Skip to content

Commit 98a92e8

Browse files
Remi-GauRemi-Gau
authored
[STY] pacify remark (#683)
1 parent d71f655 commit 98a92e8

File tree

2 files changed

+76
-60
lines changed

2 files changed

+76
-60
lines changed

‎docs/collaboration/index.md‎

Lines changed: 61 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -65,66 +65,78 @@ and follow the [BEP Guidelines](../extensions/guidelines.md)
6565

6666
## Becoming a BIDS maintainer
6767

68-
##### Why become a maintainer?
68+
### Why become a maintainer?
6969

7070
As a BIDS maintainer you may get the chance to:
7171

72-
* Learn to work as a team
73-
* Bring your expertise to the BIDS maintainers group and cover technical blind spots it may have
74-
* Improving your technical writing skills (for example documentation)
75-
* Learn to work with continuous integration and deployment
76-
* Advise and participate in the development of BIDS extensions that are most commonly associated with a publication
77-
78-
##### Responsibilities
79-
80-
* Maintainers need to be loosely aware of the entire project
81-
and use their knowledge to facilitate and initiate interactions
82-
between different nodes of the project
83-
and determine a reasonable and timely order for features to be added and issues to be resolved.
84-
* Maintainers direct other BIDS contributors in reviewing PRs,
85-
writing clarifications to the specification, or other contributions.
86-
* Maintainers ensure that all contributors maintain a friendly and welcoming tone
87-
to encourage productive conversations.
88-
* If no work team is suitable or available,
89-
the final responsibility of getting the work done lies with the maintainers.
90-
* The development of each BIDS extension proposal should be "followed"
91-
by at least one maintainer who acts as a preferential point of contact
92-
between the BIDS maintainers and the BEP leads.
72+
- Learn to work as a team
73+
- Bring your expertise to the BIDS maintainers group and cover technical blind spots it may have
74+
- Improving your technical writing skills (for example documentation)
75+
- Learn to work with continuous integration and deployment
76+
- Advise and participate in the development of BIDS extensions that are most commonly associated with a publication
77+
78+
### Responsibilities
79+
80+
- Maintainers need to be loosely aware of the entire project
81+
and use their knowledge to facilitate and initiate interactions
82+
between different nodes of the project
83+
and determine a reasonable and timely order for features to be added and issues to be resolved.
84+
85+
- Maintainers direct other BIDS contributors in reviewing PRs,
86+
writing clarifications to the specification, or other contributions.
87+
88+
- Maintainers ensure that all contributors maintain a friendly and welcoming tone
89+
to encourage productive conversations.
90+
91+
- If no work team is suitable or available,
92+
the final responsibility of getting the work done lies with the maintainers.
93+
94+
- The development of each BIDS extension proposal should be "followed"
95+
by at least one maintainer who acts as a preferential point of contact
96+
between the BIDS maintainers and the BEP leads.
9397

9498
Apart from these abstract and general responsibilities,
9599
maintainers within the BIDS community also need to ensure that the following tasks get done:
96100

97-
* Keeping the
98-
[Contributors wiki](https://github.com/bids-standard/bids-specification/wiki/Recent-Contributors)
99-
up to date and assisting new contributors with adding their credits,
100-
and performing community inquiries to ensure contributors are credited in the
101-
[Contributors appendix](https://bids-specification.readthedocs.io/en/stable/appendices/contributors.html)
102-
* Deciding what constitutes a contribution worth adding to the "Contributors list"
103-
* Preparing a monthly report to the BIDS Steering Group.
104-
The monthly report is in the form of milestones, issues addressed,
105-
and open issues raised in the past month and goals/plans for the next month.
106-
The BIDS Steering Group may ask for additional information or propose a meeting to further discuss report items.
107-
The report format and meetings are at the discretion of the BIDS Steering Group.
101+
- Keeping the
102+
[Contributors wiki](https://github.com/bids-standard/bids-specification/wiki/Recent-Contributors)
103+
up to date and assisting new contributors with adding their credits,
104+
and performing community inquiries to ensure contributors are credited in the
105+
[Contributors appendix](https://bids-specification.readthedocs.io/en/stable/appendices/contributors.html)
106+
107+
- Deciding what constitutes a contribution worth adding to the "Contributors list"
108+
109+
- Preparing a monthly report to the BIDS Steering Group.
110+
The monthly report is in the form of milestones, issues addressed,
111+
and open issues raised in the past month and goals/plans for the next month.
112+
The BIDS Steering Group may ask for additional information or propose a meeting to further discuss report items.
113+
The report format and meetings are at the discretion of the BIDS Steering Group.
108114

109115
Maintainers are not expected to individually be responsible for all the responsibilities listed.
110116
Rather, the responsibilities are distributed amongst the entire group.
111117

112-
##### Organization
113-
114-
* The group of maintainers are a group of people with the above mentioned responsibilities,
115-
who commit to convene bi-weekly meetings to discuss the project.
116-
* One lead maintainer represents the group to other BIDS Groups, mediates disagreement among members,
117-
and casts deciding votes when needed (tie break).
118-
Note that the maintainers will always strive for consensus decision making, and will try to avoid resorting to voting.
119-
* The lead maintainer may delegate any of their duties to another maintainer.
120-
* The lead maintainer is appointed collectively by the group of maintainers, preferably through consensus.
121-
* If no one else does, the lead maintainer sets the schedule for the maintainers meeting.
122-
* Additions to and departures from the group are negotiated collectively between the lead maintainer
123-
and the new/departing members, as they involve the redistribution of duties.
124-
* If a maintainer wishes to serve for a limited term, that can be arranged at the start. Otherwise, due notice is expected.
125-
* See also "How to become a maintainer?" below
126-
127-
##### How to become a maintainer?
118+
### Organization
119+
120+
- The group of maintainers are a group of people with the above mentioned responsibilities,
121+
who commit to convene bi-weekly meetings to discuss the project.
122+
123+
- One lead maintainer represents the group to other BIDS Groups, mediates disagreement among members,
124+
and casts deciding votes when needed (tie break).
125+
Note that the maintainers will always strive for consensus decision making, and will try to avoid resorting to voting.
126+
127+
- The lead maintainer may delegate any of their duties to another maintainer.
128+
- The lead maintainer is appointed collectively by the group of maintainers, preferably through consensus.
129+
- If no one else does, the lead maintainer sets the schedule for the maintainers meeting.
130+
131+
- Additions to and departures from the group are negotiated collectively between the lead maintainer
132+
and the new/departing members, as they involve the redistribution of duties.
133+
134+
- If a maintainer wishes to serve for a limited term, that can be arranged at the start.
135+
Otherwise, due notice is expected.
136+
137+
- See also "How to become a maintainer?" below
138+
139+
### How to become a maintainer?
128140

129141
If you are interested in becoming a BIDS maintainer,
130142
please get in contact with an active BIDS maintainer

‎docs/extensions/guidelines.md‎

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -47,17 +47,21 @@ for storing diffusion metadata.
4747

4848
Before proposing an extension to add a file format, consider these criteria.
4949

50-
1. The format must be free and open with open-access documentation
51-
and an open-source implementation for reading and writing.
52-
2. The format must be widely supported in external software.
53-
3. The format must add value to the existing BIDS-supported formats
54-
or be widely adopted in existing datasets.
55-
4. An active community should develop the format or have established
56-
and demonstrable procedures for proposal, review, and acceptance
57-
of fixes and enhancements from the public.
58-
5. The format must meet the technical requirements of
59-
neuroscientific workflows, such as saving numerical
60-
data with high precision.
50+
1. The format must be free and open with open-access documentation
51+
and an open-source implementation for reading and writing.
52+
53+
1. The format must be widely supported in external software.
54+
55+
1. The format must add value to the existing BIDS-supported formats
56+
or be widely adopted in existing datasets.
57+
58+
1. An active community should develop the format or have established
59+
and demonstrable procedures for proposal, review, and acceptance
60+
of fixes and enhancements from the public.
61+
62+
1. The format must meet the technical requirements of
63+
neuroscientific workflows, such as saving numerical
64+
data with high precision.
6165

6266
These criteria will be reviewed by people previously or currently
6367
involved in the relevant domain area

0 commit comments

Comments
 (0)