edit README

NIVANorge · Nov 13, 2023 · fefc4f1 · fefc4f1
1 parent b442037
commit fefc4f1
Show file tree

Hide file tree

Showing 11 changed files with 40 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -14,11 +14,50 @@ Currently, the following index calculations are supported:
 - HBI2
 - functions to calculate nEQR normalization
 
-
 ## Release process
 
 1. do appropriate changes, either locally or on a branch
 2. commit changes on main
 3. bump the version number in [pyproject.toml](./pyproject.toml#L3)
 4. push to main branch. This triggers deploy job in (github actions)[https://github.com/NIVANorge/begroing-index/actions]
 5. new version should appear at https://pypi.org/project/begroing-index/
+
+## For researchers: How to add genus/species and values
+
+**STEP 1:** In the github repository front-page, click on **indicator_values** folder
+
+![Click on indicator_values folder](./docs/images/step1.png)
+
+**STEP 2:** Select the file to edit, between `indicator_values_AIP.csv` and `indicator_values_PIT.csv`
+
+![Select a file](./docs/images/step2.png)
+
+**STEP 3:** Click on the pencil icon to edit the file
+
+![Click on edit the file](./docs/images/step3.png)
+
+**STEP 4:** Add the desired genus/species with its value, separated by a semicolon `;`. See line 266 in the example below. Then click on **Commit changes...**
+
+![Edit the file](./docs/images/step4.png)
+
+**STEP 5:** This will redirect to a **pull request form**. Add a description and select a reviewer. The reviewer should be someone who can approve your pull request, if in doubt, email <miljoinformatikk@niva.no> to ask or select one of the people listed under contributors on the right column of the repository's front-page.
+
+![Select reviewer1](./docs/images/step5A.png)
+
+![Select reviewer3](./docs/images/step5B.png)
+
+**STEP 6:** Click on **Create pull request**.
+
+![Click on create pull request](./docs/images/step6.png)
+
+**STEP 7:** Select **Create a new branch for this commit and start a pull request**.
+
+![Select new branch option](./docs/images/step7.png)
+
+**STEP 8:** Click on **Propose changes**.
+
+![Click on propose changes](./docs/images/step8.png)
+
+**STEP 9:** The reviewer will be notified of your request and will approve it or suggest modifications. You will be notified of any activities by email.
+
+![Reviewer pending](./docs/images/step9.png)
diff --git a/docs/images/step1.png b/docs/images/step1.png
diff --git a/docs/images/step2.png b/docs/images/step2.png
diff --git a/docs/images/step3.png b/docs/images/step3.png
diff --git a/docs/images/step4.png b/docs/images/step4.png
diff --git a/docs/images/step5A.png b/docs/images/step5A.png
diff --git a/docs/images/step5B.png b/docs/images/step5B.png
diff --git a/docs/images/step6.png b/docs/images/step6.png
diff --git a/docs/images/step7.png b/docs/images/step7.png
diff --git a/docs/images/step8.png b/docs/images/step8.png
diff --git a/docs/images/step9.png b/docs/images/step9.png