From a0b75140f00fec91b9f538d55b096475a59a139a Mon Sep 17 00:00:00 2001 From: Sebastien Tourbier Date: Thu, 5 Nov 2020 16:44:55 +0100 Subject: [PATCH] DOC: update info to add contributor to the list [skip ci] --- documentation/contributing.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/documentation/contributing.rst b/documentation/contributing.rst index 12ad31776..c9407a997 100644 --- a/documentation/contributing.rst +++ b/documentation/contributing.rst @@ -126,17 +126,18 @@ Not listed as a contributor? ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ This is easy, MIALSRTK has the `all contributors bot `_ installed. + Just comment on Issue or Pull Request (PR), asking @all-contributors to add you as contributor:: @all-contributors please add for -****: See the `Emoji Key Contribution Types Reference `_ for a list of valid `contribution` types. +``: See the `Emoji Key Contribution Types Reference `_ for a list of valid `contribution` types. -The all-contributors bot will then create a PR to add you in the README, then reply with the pull request details. +The all-contributors bot will create a PR to add you in the README and reply with the pull request details. When the PR is merged you will have to make an extra Pull Request where you have to: - 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. + 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 `.