Skip to content

Commit db39e7f

Browse files
committed
DOC: Improve the "Recognizing contributions" section
Improve the "Recognizing contributions" section: - Keep the mentions to the `.zenodo.json` and updating script file generic and provide specific examples. - Refer to the new `.maint/update_authors.py` script instead of the old `.maintenance/update_zenodo.py` script.
1 parent 2aa2663 commit db39e7f

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/community/CONTRIBUTING.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -292,18 +292,21 @@ myworkflow_rh_wf = init_workflow_wf(name='myworkflow_rh_wf')
292292

293293
We welcome and recognize all contributions regardless their size, content or scope:
294294
from documentation to testing and code development.
295-
You can see a list of current developers and contributors in our [zenodo file][link_zenodo].
295+
You can see a list of current developers and contributors in the `.zenodo.json` file
296+
of the corresponding repository. See [zenodo file][link_zenodo] for an example.
296297
Note that the `.zenodo.json` file is generated automatically, digesting data
297298
from the `maint/MAINTAINERS.md` and `maint/CONTRIBUTORS.md` files (and from
298299
the `maint/PIs.md` and `maint/FORMER.md` files, if applicable).
299300
New contributors should add their names to the `maint/CONTRIBUTORS.md` file.
300301
Contributors are promoted to the `maint/MAINTAINERS.md` list following the
301302
*NiPreps* governance model.
302303
Governance information can be found in the [GOVERNANCE repository][link_governance_repository].
303-
Before every release, a new [zenodo file][link_zenodo] will be generated.
304-
The [update script][link_update_script] will also sort creators and contributors by
305-
the relative size of their contributions, as provided by the `git-line-summary` utility
306-
distributed with the `git-extras` package.
304+
Before every release, a new `.zenodo.json` will be generated through the
305+
`.maint/update_authors.py` script that dwells in the repository at issue.
306+
The script will also sort creators and contributors by the relative size of their
307+
contributions, as provided by the `git-line-summary` utility distributed with the
308+
`git-extras` package. See [update script][link_update_script] for
309+
an example of the script.
307310
Last positions in both the *creators* and *contributors* list will be reserved to
308311
the project leaders.
309312
These special positions can be revised to add names by punctual request and revised for

0 commit comments

Comments
 (0)