Skip to content

Commit 1f72bc2

Browse files
DOC: Clarify how contributors list is updated (#57)
Clarify how contributors list is updated. Co-authored-by: Oscar Esteban <code@oscaresteban.es>
1 parent 4e9aa94 commit 1f72bc2

File tree

2 files changed

+19
-2
lines changed

2 files changed

+19
-2
lines changed

docs/community/CONTRIBUTING.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,6 +290,13 @@ myworkflow_rh_wf = init_workflow_wf(name='myworkflow_rh_wf')
290290
We welcome and recognize all contributions regardless their size, content or scope:
291291
from documentation to testing and code development.
292292
You can see a list of current developers and contributors in our [zenodo file][link_zenodo].
293+
Note that the `.zenodo.json` file is generated automatically, digesting data
294+
from the `maint/MAINTAINERS.md` and `maint/CONTRIBUTORS.md` files (and from
295+
the `maint/PIs.md` and `maint/FORMER.md` files, if applicable).
296+
New contributors should add their names to the `maint/CONTRIBUTORS.md` file.
297+
Contributors are promoted to the `maint/MAINTAINERS.md` list following the
298+
*NiPreps* governance model.
299+
Governance information can be found in the [GOVERNANCE repository][link_governance_repository].
293300
Before every release, a new [zenodo file][link_zenodo] will be generated.
294301
The [update script][link_update_script] will also sort creators and contributors by
295302
the relative size of their contributions, as provided by the `git-line-summary` utility
@@ -344,6 +351,8 @@ You're awesome. :wave::smiley:
344351

345352
[link_neurostars]: https://neurostars.org/tags/fmriprep
346353

354+
[link_governance_repository]: https://github.com/nipreps/GOVERNANCE
355+
347356
[link_git]: https://git-scm.com/
348357
[link_handbook]: https://guides.github.com/introduction/git-handbook/
349358
[link_swc_intro]: http://swcarpentry.github.io/git-novice/

docs/community/members.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,15 @@ However, because of the scientific domain of *NiPreps*, the community features s
44
structure from *meritocracy models* to prescribe the order in the
55
authors list of [new papers about these tools](CONTRIBUTING.md#publications).
66

7-
## Developers
7+
## Historical note
8+
9+
The sections below provide a note on how contributions to the *NiPreps*
10+
projects were historically acknowledged.
11+
The scheme below has been substituted by a robuster strategy
12+
that is described in the [contributor recognition](CONTRIBUTING.md#recognizing-contributions)
13+
section.
14+
15+
### Developers
816

917
Developers are members of a wonderful team _driving the project_.
1018
Names and contacts of all developers are included in the
@@ -13,7 +21,7 @@ Examples of steering activities that _drive the project_ are: actively participa
1321
follow-up meetings, leading documentation sprints, helping in the design of the tool and definition of the roadmap,
1422
providing resources (in the broad sense, including funding), code-review, etc.
1523

16-
## Contributors
24+
### Contributors
1725

1826
Contributors enlisted in the
1927
[`.maint/contributors.json` file](https://github.com/nipreps/fmriprep/blob/master/.maint/contributors.json) of each project

0 commit comments

Comments
 (0)