Skip to content

Commit

Permalink
DOC: update info to add contributor to the list [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
sebastientourbier committed Nov 5, 2020
1 parent aafe470 commit 32e46bd
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions documentation/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,8 @@ How to build the documentation locally
.. note::
Make sure to have activated the conda environment ``pymialsrtk-env`` before running the script ``build_sphinx_docs.sh``.

Not listed as contributor?
~~~~~~~~~~~~~~~~~~~~~~~~~~~
Not listed as a contributor?
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This is easy, MIALSRTK has the `all contributors bot <https://allcontributors.org/docs/en/bot/usage>`_ installed.
Just comment on Issue or Pull Request (PR), asking @all-contributors to add you as contributor::
Expand All @@ -138,7 +138,7 @@ When the PR is merged you will have to make an extra Pull Request where you have

1. add your entry in the .zenodo.json (for that you will need an ORCID ID - https://orcid.org/). Doing so, you will appear as a contributor on Zenodo in the future version releases of MIALSRTK. Zenodo is used by MIALSRTK to publish and archive each of the version release with a unique Digital Object Identifier (DOI), which can then be used for citation.

2. update the content of the table in ``documentation/contributors.rst`` with the new content generated by the bot in the README. Doing so, you will appear in the :ref:`Contributing Page <contributing>`.
2. update the content of the table in `documentation/contributors.rst` with the new content generated by the bot in the README. Doing so, you will appear in the :ref:`Contributing Page <contributing>`.

------------

Expand Down

0 comments on commit 32e46bd

Please sign in to comment.