Commit a8e57209 authored by Thibaud Marie Eric Buffet's avatar Thibaud Marie Eric Buffet
Browse files

SIGMON-111: update the CONTRIBUTING file with PER suggestions

parent 2cb22a08
......@@ -25,15 +25,18 @@ Note: issues can move back to their previous steps if needed.
- Move the issue to the `IN PROGRESS` column.
### 2. A new repository `hwc_working` has been created. All the notebooks can be updated from this repository.
### 2. The repository `hwc_working` has been created or loaded. All the notebooks can be updated from this repository.
- Update and modify notebooks from `hwc_working` in order to fix the issue.
- __IMPORTANT__ -> Before pushing all the notebooks must stay __CLEAN__ !! They should not contain any SWAN execution outputs.
To clean a notebook click on the tab `CELL` --> `All Output->Clear`
- __IMPORTANT__ -> Increment the version number in the `hwc_working/__init__.py` file.
- You can continue to work on your Notebooks for several days by repeating step 1. when reloading a SWAN session.
- __IMPORTANT__ -> Issues can occur if multiple people are working in parallel on the same Notebooks. Make sure to synchronise with other developers.
### 3. Commit and push your changes to Gitlab:
- Open the SWAN terminal
- __IMPORTANT__ -> Before pushing all the notebooks must stay __CLEAN__ !! They should **NOT** contain any SWAN execution outputs.
To clean a notebook click on the tab `CELL` --> `All Output->Clear`
- __IMPORTANT__ -> Increment the version number in the `hwc_working/__init__.py` file.
- Open the SWAN terminal.
- Then run the command `source /eos/project/l/lhcsm/public/contributor_push.sh`
- (Note the working directory `hwc_working` has been deleted, if you want to reload it you can run in the terminal `source /eos/project/l/lhcsm/public/contributor.sh`)
......@@ -54,7 +57,7 @@ Note: issues can move back to their previous steps if needed.
### RELEASE TO PRO
### 6. When changes are validated, you must __TAG__ the `master` branch with the previously given __version__ __number__: https://gitlab.cern.ch/LHCData/lhc-sm-hwc/-/tags/new
### 6. When changes are validated, you must __TAG__ the `master` branch with the previously given **_version_ _number_**: https://gitlab.cern.ch/LHCData/lhc-sm-hwc/-/tags/new
- The `PRO` [pipeline](https://gitlab.cern.ch/LHCData/lhc-sm-api/-/pipelines) is now triggered. Wait until the pipeline is completed and all steps are green.
- To load the `PRO` environment you can restart the SWAN configuration with the option Environment script: `/eos/project/l/lhcsm/public/packages_notebooks.sh`
##### On JIRA dashboard:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment