Skip to content

Commit 4d9551f

Browse files
authored
Merge pull request #778 from nipy/community_docs
Add community docs
2 parents 7c69442 + 028e987 commit 4d9551f

File tree

3 files changed

+124
-1
lines changed

3 files changed

+124
-1
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# Community Guidelines
2+
3+
Nibabel is a [NIPY](https://nipy.org) project, and we strive to adhere to the
4+
[NIPY Community Code](https://nipy.org/conduct.html), reproduced below.
5+
6+
The NIPY community is a community of practice devoted to the use of the Python programming language
7+
in the analysis of neuroimaging data. The following code of conduct is a guideline for our behavior
8+
as we participate in this community.
9+
10+
It is based on, and heavily inspired by a reading of the Python community code of conduct, the
11+
Apache foundation code of conduct, the Debian code of conduct, and the Ten Principles of Burning
12+
Man.
13+
14+
## The code of conduct for the NIPY community
15+
16+
The Neuroimaging in Python (NIPY) community is made up of members with a diverse set of skills,
17+
personalities, background, and experiences. We welcome these differences because they are the
18+
source of diverse ideas, solutions and decisions about our work. Decisions we make affect users,
19+
colleagues, and through scientific results, the general public. We take these consequences
20+
seriously when making decisions. When you are working with members of the community, we encourage
21+
you to follow these guidelines, which help steer our interactions and help keep NIPY a positive,
22+
successful, and growing community.
23+
24+
### A member of the NIPY community is:
25+
26+
#### Open
27+
28+
Members of the community are open to collaboration. Be it on the reuse of data, on the
29+
implementation of methods, on finding technical solutions, establishing best practices, and
30+
otherwise. We are accepting of all who wish to take part in our activities, fostering an
31+
environment where anyone can participate and everyone can make a difference.
32+
33+
#### Be collaborative!
34+
35+
Our work will be used by other people, and in turn we will depend on the work of others. When we
36+
make something for the benefit of others, we are willing to explain to others how it works, so that
37+
they can build on the work to make it even better. We are willing to provide constructive criticism
38+
on the work of others and accept criticism of our own work, as the experiences and skill sets of
39+
other members contribute to the whole of our efforts.
40+
41+
#### Be inquisitive!
42+
43+
Nobody knows everything! Asking questions early avoids many problems later, so questions are
44+
encouraged, though they may be directed to the appropriate forum. Those who are asked should be
45+
responsive and helpful, within the context of our shared goal of improving neuroimaging practice.
46+
47+
#### Considerate
48+
49+
Members of the community are considerate of their peers. We are thoughtful when addressing the
50+
efforts of others, keeping in mind that often-times the labor was completed simply for the good of
51+
the community. We are attentive in our communications, whether in person or online, and we are
52+
tactful when approaching differing views.
53+
54+
#### Be careful in the words that you choose:
55+
56+
We value courtesy, kindness and inclusiveness in all our interactions. Therefore, we take
57+
responsibility for our own speech. In particular, we avoid:
58+
59+
* Personal insults.
60+
* Violent threats or language directed against another person.
61+
* Sexist, racist, or otherwise discriminatory jokes and language.
62+
* Any form of sexual or violent material.
63+
* Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such
64+
as IRC channel history.
65+
* Excessive or unnecessary profanity.
66+
* Repeated harassment of others. In general, if someone asks you to stop, then stop.
67+
* Advocating for, or encouraging, any of the above behaviour.
68+
69+
#### Try to be concise in communication
70+
71+
Keep in mind that what you write once will be read by many others. Writing a short email means
72+
people can understand the conversation as efficiently as possible. Even short emails should always
73+
strive to be empathetic, welcoming, friendly and patient. When a long explanation is necessary,
74+
consider adding a summary.
75+
76+
Try to bring new ideas to a conversation, so that each message adds something unique to the
77+
conversation. Keep in mind that, when using email, the rest of the thread still contains the other
78+
messages with arguments that have already been made.
79+
80+
Try to stay on topic, especially in discussions that are already fairly long and complex.
81+
82+
#### Respectful
83+
84+
Members of the community are respectful. We are respectful of others, their positions, their
85+
skills, their commitments, and their efforts. We are respectful of the volunteer and professional
86+
efforts that permeate the NIPY community. We are respectful of the processes set forth in the
87+
community, and we work within them. When we disagree, we are courteous and kind in raising our
88+
issues.
89+
90+
## Incident Reporting
91+
92+
We put great value on respectful, friendly and helpful communication.
93+
94+
If you feel that any of our Nibabel communications lack respect, or are unfriendly or unhelpful,
95+
please try the following steps:
96+
97+
* If you feel able, please let the person who has sent the email or comment that you found it
98+
disrespectful / unhelpful / unfriendly, and why;
99+
100+
* If you don't feel able to do that, or that didn't work, please contact Chris Markiewicz directly
101+
by email (<[email protected]>), and he will do his best to resolve it.
102+
If you don't feel comfortable contacting Chris, please email Matthew Brett
103+
(<[email protected]>) instead.
104+
105+
## Attribution
106+
107+
The vast majority of the above was taken from the NIPY Code of Conduct.

.github/CONTRIBUTING.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Contributing to NiBabel
2+
3+
Welcome to the NiBabel repository!
4+
We're excited you're here and want to contribute.
5+
6+
Please see the [NiBabel Developer Guidelines][link_devguide] on our
7+
on our [documentation website][link_docs].
8+
9+
These guidelines are designed to make it as easy as possible to get involved.
10+
If you have any questions that aren't discussed in our documentation, or it's
11+
difficult to find what you're looking for, please let us know by opening an
12+
[issue][link_issues]!
13+
14+
[link_docs]: https://nipy.org/nibabel
15+
[link_devguide]: https://nipy.org/nibabel/devel/devguide.html
16+
[link_issues]: https://github.com/poldracklab/fmriprep/issues

doc/source/devel/devguide.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Code Documentation
2828

2929
All documentation should be written using Numpy documentation conventions:
3030

31-
https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#docstring-standard
31+
https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard
3232

3333

3434
Git Repository

0 commit comments

Comments
 (0)