Branches Naming: Difference between revisions

From The Yambo Project
Jump to navigation Jump to search
(Created page with "== Branch Naming == thumb|Branch Naming structure")
 
Line 1: Line 1:
== Branch Naming ==
[[File:2023-02-02 14-38.png|thumb|left|Branch Naming structure]]


[[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
 
* '''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

Revision as of 14:49, 2 February 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

  • 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