CONTRIBUTING.md 3.2 KB
Newer Older
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
## Contributing Manual


### Issue reporting and tracking
To report issues and track their progress we use a [JIRA dashboard](https://its.cern.ch/jira/secure/RapidBoard.jspa?rapidView=7215&projectKey=SIGMON&view=detail).

- When a new issue is raised, one can report it by creating a new story on the JIRA board on the `Create` button.
- On step 1. below: The issue moves to the `IN PROGRESS` column as someone starts working on it.
- On step 4. below: When the merge request is open the issue is moved to the `REVIEW` column.
- On step 5. below: When the `DEV` environment has been validated, move the task to `VALIDATION`
- On step 6. below: The issue has been fixed and can be moved to `DONE` column.

Note: issues can move back to their previous steps if needed.

### Fixing an issue

Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
17
 1. Open a new SWAN session with the configuration
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
18
19
20
21
22
23
    - Software stack: `NXCals Python3`
    - Platform: `CentOS 7 (gcc7)` - default
    - Environment script: `/eos/project/l/lhcsm/public/contributor.sh`
    - Number of cores: `4`
    - Memory: `16 GB`
    - Spark cluster: `BE NXCALS (NXCals)`
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
24
   
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
25
26
   
 2. A new repository `hwc_working` has been created. All the notebooks can be updated from this repository.
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
27
28
29
30
    - Update and modify notebooks 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.  
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
31
   
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
32

Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
33
 3. Commit and push your changes to Gitlab:
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
34
35
36
37
    - Open the SWAN terminal 
    - Authenticate by running `kinit` and entering your password.
    - 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`)
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
38
39
   

Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
40
 4. Open a merge request on [Gitlab with your changes to be reviewed](https://gitlab.cern.ch/LHCData/lhc-sm-hwc/-/merge_requests/new?utf8=%E2%9C%93&merge_request%5Bsource_project_id%5D=90588&merge_request%5Bsource_branch%5D=dev&merge_request%5Btarget_project_id%5D=90588&merge_request%5Btarget_branch%5D=master): 
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
41
42
    - select source branch `dev`
    - select target branch `master`
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
43
   
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
44

Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
45
 5. Once the merge request has been reviewed and approved then click on the `Merge` button of the merge request page.
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
46
47
    - The `DEV` [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 `DEV` environment you can restart the SWAN configuration with the option Environment script: `/eos/project/l/lhcsm/public/packages_notebooks_dev.sh`
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
48
49
   

Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
50
 6. When changes are validated, you must __TAG__ the `master` branch with the new version: https://gitlab.cern.ch/LHCData/lhc-sm-hwc/-/tags/new
Thibaud Marie Eric Buffet's avatar
Thibaud Marie Eric Buffet committed
51
52
    - 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`