AMAROC-848 update contribution guidelines / citation file

MeteoSwiss · Sep 4, 2024 · a36394a · a36394a
1 parent a3a4d52
commit a36394a
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 7 deletions.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -13,5 +13,6 @@ Please tag them using `#`, e.g. `Fixed #42`.
 - [ ] New code follows the project's style.
 - [ ] New code is compatible with the 3-Clause BSD license.
 - [ ] CHANGELOG has been updated.
-- [ ] AUTHORS has been updated.
+- [ ] docs have been updated
+- [ ] code authors have been updated in CITATION.cff.
 - [ ] Copyright years in module docstrings have been updated.
diff --git a/AUTHORS b/AUTHORS
diff --git a/CITATION.cff b/CITATION.cff
@@ -1,6 +1,6 @@
 
 cff-version: 1.2.0
-message: If ampycloud was useful for your research, please cite both the dedicated article (from preferred-citation) and the software itself.
+message: If ampycloud was useful for your research, please cite both the dedicated article (https://doi.org/10.5194/amt-17-4891-2024) and the software itself.
 type: software
 authors:
   - family-names: Vogt

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -42,6 +42,11 @@ Please be sure to read (and understand the implications) of the
 
 ampycloud is being developed in a **public** repository under the [MeteoSwiss organization](https://github.com/MeteoSwiss/ampycloud) on Github. The documentation, generated using Sphinx, is hosted as Github Pages on the `gh-pages` branch of the repo, and is visible at https://MeteoSwiss.github.io/ampycloud.
 
+### New developer
+
+Please make sure to read the instructions below carefully. In addition, please add your name to the software part of the [citation](#CITATION.cff) file at the latest before triggering
+a [release](#release-mechanisms)(the top part defines the citation for the software, the bottom part defines the citation of the scientific article) and make sure to properly
+update the CHANGELOG and the [documentation](#documentation) if necessary.
 
 ### Branching model
 
@@ -226,8 +231,9 @@ You should of course feel free to use more of the tools offered by
 
 ### Documentation
 
-There is a scientific article about the ampycloud **algorithm** in preparation. It will complement
-the [Sphinx documentation](https://MeteoSwiss.github.io/ampycloud) that contains all the important elements required to use the ampycloud **Python package**.
+There is a [scientific article](https://amt.copernicus.org/articles/17/4891/2024/) about the ampycloud **algorithm** v2.0.0. It complements
+the [Sphinx documentation](https://MeteoSwiss.github.io/ampycloud) that contains all the important elements required to use the ampycloud **Python package**. Scientific changes
+on top of version v2.0.0 must be added to [the corresponding section in the docs](https://meteoswiss.github.io/ampycloud/changes.html).
 
 The Sphinx documentation can be generated manually as follows:
 ```