Skip to content
Snippets Groups Projects

Clean up CONTRIBUTING.md

Merged Clean up CONTRIBUTING.md
update-CONTRIBUTING into master
Merged Marco Cattaneo requested to merge update-CONTRIBUTING into master
Compare
and
1 file
+ 14
− 12
Compare changes
  • Side-by-side
  • Inline
CONTRIBUTING.md
+ 14
− 12
# General information
# General information
The project contains several active and maintained branches, such as the `201X-patches` branches.
In addition to `master`, this project contains several officialy maintained branches, with names such as `XXX-patches`.
They are all protected, meaning that code cannot be pushed into them directly but only through merge requests (MRs).
They are all protected, meaning that code cannot be pushed into them directly but only through merge requests (MRs).
This helps with the validation of code prior to making it available in the official branches for future releases.
This helps with the validation of code prior to making it available in the official branches for future releases.
## Where to commit code to
## Available supported branches
 
 
- `master` branch: new developments and updates targeting run 3. Builds on current supported platforms against latest version of Gaudi
 
 
- `run2-patches` branch: new developments targeting runs 1+2 digitisation. Builds on current supported platfroms against latest version of Gaudi
- Bug fixes for 2018 data-taking should be committed as MRs to `2018-patches`. They will then be propagated to the
- `digi14-patches` branch: for bug fixes to Boole in runs 1+2 simulation production workflows. Builds with gcc49 on slc6
`run2-patches` branch (and master if appropriate) by the applications managers.
 
 
## Where to commit code to
- Any other changes for Run 1 and Run 2 analysis (or re-reconstruction, re-stripping) should go to the `run2-patches` branch.
- Bug fixes specific to digi14 should be committed to `digi14-patches` branch.
They will then be propagated to `master` (if relevant also for Upgrade) by the applications managers.
- Any changes specific to Upgrade should *only* got to `master`. When making a MR to `master`, please make it initially as WIP and add
- Any new developments for Run 1 and Run 2 digitisation should go to the `run2-patches` branch.
a comment when it is ready to be tested. The release manager will then test it initially in one nightly slot and, if successful,
remove the WIP for general testing
- Things may be different for bug fixes to old and/or specific versions of Boole, in which case it is probably best to discuss
- Any changes specific to Run 3 should go to `master`.
unless you know exactly what you are doing.
In doubt, please get in touch before creating a MR.
In doubt, please get in touch before creating a MR.
\ No newline at end of file