Branches Naming: Difference between revisions

From The Yambo Project
Jump to navigation Jump to search
No edit summary
No edit summary
Line 14: Line 14:


* '''merged/YYY/XXX''': where we will store the branches (here '''YYY/XXX''') after being merged
* '''merged/YYY/XXX''': where we will store the branches (here '''YYY/XXX''') after being merged
* '''unactivat/YYY/XXX''': where the branches inactive for more than 1 year will be moved
* '''unactive/YYY/XXX''': where the branches inactive for more than 1 year will be moved

Revision as of 12:20, 16 October 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

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
  • unactive/YYY/XXX: where the branches inactive for more than 1 year will be moved