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 32e46bd commit a0b7514
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions documentation/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,17 +126,18 @@ 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::

@all-contributors please add <github_username> for <contributions>

**<contribution>**: See the `Emoji Key Contribution Types Reference <https://github.com/all-contributors/all-contributors/blob/master/docs/emoji-key.md>`_ for a list of valid `contribution` types.
`<contribution>`: See the `Emoji Key Contribution Types Reference <https://github.com/all-contributors/all-contributors/blob/master/docs/emoji-key.md>`_ 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 <contributing>`.

Expand Down

0 comments on commit a0b7514

Please sign in to comment.