Branches Naming: Difference between revisions

From The Yambo Project
Jump to navigation Jump to search
m (Added fixes category)
mNo edit summary
Line 5: Line 5:
If however this branch aims at be merged with the develop the following naming convention should be respected
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
* '''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
* '''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...
* '''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...
* '''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
* '''tech/XXX''': New technical aspects/modules/procedures. Examples: tech/CUDA, tech/FFTW, tech/SLK

Revision as of 14:08, 23 March 2023

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