CONTRIBUTING.md 1.42 KB
Newer Older
Philipp Hörist's avatar
Philipp Hörist committed
1
# Project
Philipp Hörist's avatar
Philipp Hörist committed
2

Philipp Hörist's avatar
Philipp Hörist committed
3
If you want to create a fork and use an external account (Github, Google) drop us a message at the Gajim support [group chat](xmpp:gajim@conference.gajim.org?join) so we can give you the necessary rights
Philipp Hörist's avatar
Philipp Hörist committed
4

5
6
## Versioning

7
8
9
10
11
12
13
14
┌────── Major (Will not change unless we switch GTK version)  
│ ┌───── Minor (Changes when new features are introduced  
│ │ ┌──── Micro (Used for hotfixes and small changes)  
│ │ │ ┌─── Only used while developing  
│ │ │ │  
│ │ │ │  
│ │ │ │  
│ │ │ │  
15
16
17
18
19
20
21
22
23
24
25
26
1.3.3-dev1

## Branches

Currently there is only one stable/development branch - master.
The master branch must always be in a releasable state.

Development for bigger changes need to happen in feature branches or forks.

Previously the project maintained multiple versions of Gajim in
different stable branches, but from Gajim 1.4.0 on this approach was changed
to lower the maintenance burden and release faster.
Philipp Hörist's avatar
Philipp Hörist committed
27

Philipp Hörist's avatar
Philipp Hörist committed
28
29
30

# Commit Messages

Philipp Hörist's avatar
Philipp Hörist committed
31
32
33
If you are not familiar with Git please read the [HowTo](https://dev.gajim.org/gajim/gajim/wikis/development/howtogit)

A good article regarding [good commit messages](https://chris.beams.io/posts/git-commit/)
Philipp Hörist's avatar
Philipp Hörist committed
34
35
36

Every commit message must be prefixed with one of the following tags:

37
- ci
Philipp Hörist's avatar
Philipp Hörist committed
38
39
40
41
42
43
44
45
46
47
48
49
- feat
- fix
- perf
- refactor
- chore
- other

Further the first letter after the tag must be upper case

Example:

`feat: New Button which does something`