Merge branch 'master' into erp5
[slapos.git] / 00.Repository.Rules.txt
1 SlapOS repository rules
2 =======================
3
4 Short version for impatient
5 ---------------------------
6
7 'master' branch is always stable. One shall never work in this branch. One
8 shall expect reversion or removal of his commits in 'master' branch, if they
9 are not because of merging another branch.
10
11 Everyone has to create branch, basing on 'master' or any other branch. All
12 work shall be done in such branch. It is advised to review it before merging
13 into 'master'. It is very good habit to tag such merges.
14
15 A bit more background
16 ---------------------
17
18 SlapOS repository 'master' branch is supposed to be stable. No new work is
19 accepted on this branch. Each time someone uses (clones, extends) 'master'
20 branch it is supposed to work (as far as it was tested).
21
22 Tags on 'master' branch are supposed to be repeatable software definitions
23 forever. All versions and external links shall be setup in a way, that they
24 wouldn't change in day, month, year, etc.
25
26 Everyone can make his own branch to introduce new software to SlapOS. There
27 are no rules about those branches, as each software is specific.
28
29 It is good idea to ask for review before merging changes into 'master' branch.
30 Peer review can detect issues not detected by testing, development or self
31 analysis.
32
33 After some software is stabilised and no more work is planned it is acceptable
34 to remove such abandoned branch in order to minimise amount of branches.