Branches Naming: Difference between revisions
Jump to navigation
Jump to search
(Created page with "== Branch Naming == thumb|Branch Naming structure") |
No edit summary |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
[[File:2023-02-02 14-38.png|thumb|Branch Naming structure]] | |||
Of course the developers can use any name for their branch. | |||
If however this branch aims at be merged with the develop the following naming convention should be respected | |||
* '''fixes-XXX''': Fix specific (groups of) bugs. To be used for extended fixes, otherwise there is the branch bug-fixes. Examples: fixes-issue-XXX | |||
* '''maintain-XXX''': Maintenance of specific modules/procedure/.... Limited modifications. No revolutions. Examples: maintain/RIM, maintain/cutoff | |||
* '''phys-XXX''': New physics. Examples: phys-ph-dyn, phys-raman, phys-vertex... | |||
* '''refact-XXX''': Deep refactorization of specific procedures/modules. Examples: refact-FFT, refact-parallel-IO, refact-msg... | |||
* '''tech-XXX''': New technical aspects/modules/procedures. Examples: tech-CUDA, tech-FFTW, tech-SLK | |||
* '''feature-XXX''': New feature | |||
In addition the developers team will use two more labels | |||
* '''merged/YYY-XXX''': where we will store the branches (here '''YYY-XXX''') after being merged | |||
* '''nonactive/YYY-XXX''': where the branches inactive for more than 1 year will be moved | |||
Latest revision as of 07:49, 20 October 2023
Of course the developers can use any name for their branch.
If however this branch aims at be merged with the develop the following naming convention should be respected
- fixes-XXX: Fix specific (groups of) bugs. To be used for extended fixes, otherwise there is the branch bug-fixes. Examples: fixes-issue-XXX
- maintain-XXX: Maintenance of specific modules/procedure/.... Limited modifications. No revolutions. Examples: maintain/RIM, maintain/cutoff
- phys-XXX: New physics. Examples: phys-ph-dyn, phys-raman, phys-vertex...
- refact-XXX: Deep refactorization of specific procedures/modules. Examples: refact-FFT, refact-parallel-IO, refact-msg...
- tech-XXX: New technical aspects/modules/procedures. Examples: tech-CUDA, tech-FFTW, tech-SLK
- feature-XXX: New feature
In addition the developers team will use two more labels
- merged/YYY-XXX: where we will store the branches (here YYY-XXX) after being merged
- nonactive/YYY-XXX: where the branches inactive for more than 1 year will be moved