Skip to content

Commit 833ec22

Browse files
CzakiCzaki
committed
initial reformat
1 parent ac24a78 commit 833ec22

7 files changed

+418
-149
lines changed

‎.pre-commit-config.yaml

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
repos:
2+
- repo: https://github.com/executablebooks/mdformat
3+
rev: 0.7.16
4+
hooks:
5+
- id: mdformat
6+
exclude: .github|docs/release|EULA.md
7+
- repo: https://github.com/jackdewinter/pymarkdown
8+
rev: v0.9.8
9+
hooks:
10+
- id: pymarkdown
11+
exclude: .github|docs/release|EULA.md

‎docs/api/index.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
(api)=
2+
23
# API Reference
34

45
Information on specific functions, classes, and methods.
56

67
```{tableofcontents}
7-
```
8+
```

‎docs/community/code_of_conduct.md

Lines changed: 119 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,89 +1,162 @@
11
(napari-coc)=
2+
23
# Code of Conduct
34

45
## Introduction
56

6-
This code of conduct applies to all spaces managed by the napari project, including all public and private mailing lists, issue trackers, wikis, blogs, Twitter, and any other communication channel used by our community. The napari project does not organise in-person events, however events related to our community should have a code of conduct similar in spirit to this one.
7+
This code of conduct applies to all spaces managed by the napari project,
8+
including all public and private mailing lists, issue trackers, wikis, blogs,
9+
Twitter, and any other communication channel used by our community.
10+
The napari project does not organise in-person events, however events
11+
related to our community should have a code of conduct similar in spirit
12+
to this one.
713

8-
This code of conduct should be honored by everyone who participates in the napari community formally or informally, or claims any affiliation with the project, in any project-related activities and especially when representing the project, in any role.
14+
This code of conduct should be honored by everyone who participates in the
15+
napari community formally or informally, or claims any affiliation with the
16+
project, in any project-related activities and especially when representing
17+
the project, in any role.
918

10-
This code is not exhaustive or complete. It serves to distill our common understanding of a collaborative, shared environment and goals. Please try to follow this code in spirit as much as in letter, to create a friendly and productive environment that enriches the surrounding community.
19+
This code is not exhaustive or complete. It serves to distill our common
20+
understanding of a collaborative, shared environment and goals. Please try
21+
to follow this code in spirit as much as in letter, to create a friendly and
22+
productive environment that enriches the surrounding community.
1123

1224
## Specific guidelines
1325

1426
We strive to:
1527

16-
1. Be open. We invite anyone to participate in our community. We prefer to use public methods of communication for project-related messages, unless discussing something sensitive. This applies to messages for help or project-related support, too; not only is a public support request much more likely to result in an answer to a question, it also ensures that any inadvertent mistakes in answering are more easily detected and corrected.
17-
18-
2. Be empathetic, welcoming, friendly, and patient. We work together to resolve conflict, and assume good intentions. We may all experience some frustration from time to time, but we do not allow frustration to turn into a personal attack. A community where people feel uncomfortable or threatened is not a productive one.
19-
20-
3. Be collaborative. Our work will be used by other people, and in turn we will depend on the work of others. When we make something for the benefit of the project, we are willing to explain to others how it works, so that they can build on the work to make it even better. Any decision we make will affect users and colleagues, and we take those consequences seriously when making decisions.
21-
22-
4. Be inquisitive. Nobody knows everything! Asking questions early avoids many problems later, so we encourage questions, although we may direct them to the appropriate forum. We will try hard to be responsive and helpful.
23-
24-
5. Be careful in the words that we choose. We are careful and respectful in our communication and we take responsibility for our own speech. Be kind to others. Do not insult or put down other participants. We will not accept harassment or other exclusionary behaviour, such as:
25-
26-
> * Violent threats or language directed against another person.
27-
> * Sexist, racist, ableist, or otherwise discriminatory jokes and language.
28-
> * Posting sexually explicit or violent material.
29-
> * Posting (or threatening to post) other people’s personally identifying information (“doxing”).
30-
> * Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such as IRC channel history, without the sender’s consent.
31-
> * Personal insults, especially those using sexist, racist, or ableist terms.
32-
> * Intentional or repeated misgendering of participants who have explicitly requested to be addressed by specific pronouns.
33-
> * Unwelcome sexual attention.
34-
> * Excessive profanity. Please avoid swearwords; people differ greatly in their sensitivity to swearing.
35-
> * Repeated harassment of others. In general, if someone asks you to stop, then stop.
36-
> * Advocating for, or encouraging, any of the above behaviour.
28+
1. Be open. We invite anyone to participate in our community. We prefer to use
29+
public methods of communication for project-related messages, unless discussing
30+
something sensitive. This applies to messages for help or project-related
31+
support, too; not only is a public support request much more likely to result
32+
in an answer to a question, it also ensures that any inadvertent mistakes in
33+
answering are more easily detected and corrected.
34+
35+
2. Be empathetic, welcoming, friendly, and patient. We work together to resolve
36+
conflict, and assume good intentions. We may all experience some frustration
37+
from time to time, but we do not allow frustration to turn into a personal
38+
attack. A community where people feel uncomfortable or threatened is not
39+
a productive one.
40+
41+
3. Be collaborative. Our work will be used by other people, and in turn we will
42+
depend on the work of others. When we make something for the benefit of the
43+
project, we are willing to explain to others how it works, so that they can
44+
build on the work to make it even better. Any decision we make will affect
45+
users and colleagues, and we take those consequences seriously when making
46+
decisions.
47+
48+
4. Be inquisitive. Nobody knows everything! Asking questions early avoids
49+
many problems later, so we encourage questions, although we may direct them
50+
to the appropriate forum. We will try hard to be responsive and helpful.
51+
52+
5. Be careful in the words that we choose. We are careful and respectful in
53+
our communication and we take responsibility for our own speech. Be kind to
54+
others. Do not insult or put down other participants. We will not accept
55+
harassment or other exclusionary behaviour, such as:
56+
57+
> - Violent threats or language directed against another person.
58+
> - Sexist, racist, ableist, or otherwise discriminatory jokes and language.
59+
> - Posting sexually explicit or violent material.
60+
> - Posting (or threatening to post) other people’s personally identifying \
61+
> information (“doxing”).
62+
> - Sharing private content, such as emails sent privately or non-publicly,
63+
> or unlogged forums such as IRC channel history, without the sender’s
64+
> consent.
65+
> - Personal insults, especially those using sexist, racist, or ableist terms.
66+
> - Intentional or repeated misgendering of participants who have explicitly
67+
> requested to be addressed by specific pronouns.
68+
> - Unwelcome sexual attention.
69+
> - Excessive profanity. Please avoid swearwords; people differ greatly in
70+
> their sensitivity to swearing.
71+
> - Repeated harassment of others. In general, if someone asks you to stop,
72+
> then stop.
73+
> - Advocating for, or encouraging, any of the above behaviour.
3774
3875
## Diversity statement
3976

40-
The napari project welcomes and encourages participation by everyone. We are committed to being a community that everyone enjoys being part of. Although we may not always be able to accommodate each individual’s preferences, we try our best to treat everyone kindly.
77+
The napari project welcomes and encourages participation by everyone.
78+
We are committed to being a community that everyone enjoys being part of.
79+
Although we may not always be able to accommodate each individual’s
80+
preferences, we try our best to treat everyone kindly.
4181

42-
No matter how you identify yourself or how others perceive you: we welcome you. Though no list can hope to be comprehensive, we explicitly honour diversity in: age, culture, ethnicity, genotype, gender identity or expression, language, national origin, neurotype, phenotype, political beliefs, profession, race, religion, sexual orientation, socioeconomic status, subculture and technical ability, to the extent that these do not conflict with this code of conduct.
82+
No matter how you identify yourself or how others perceive you: we welcome you.
83+
Though no list can hope to be comprehensive, we explicitly honour diversity in:
84+
age, culture, ethnicity, genotype, gender identity or expression, language,
85+
national origin, neurotype, phenotype, political beliefs, profession, race,
86+
religion, sexual orientation, socioeconomic status, subculture and technical
87+
ability, to the extent that these do not conflict with this code of conduct.
4388

44-
Though we welcome people fluent in all languages, napari development is conducted in English.
89+
Though we welcome people fluent in all languages, napari development is
90+
conducted in English.
4591

46-
Standards for behaviour in the napari community are detailed in the Code of Conduct above. Participants in our community should uphold these standards in all their interactions and help others to do so as well (see next section).
92+
Standards for behaviour in the napari community are detailed in the Code of
93+
Conduct above. Participants in our community should uphold these standards in
94+
all their interactions and help others to do so as well (see next section).
4795

4896
## Reporting guidelines
4997

50-
We know that it is painfully common for internet communication to start at or devolve into obvious and flagrant abuse. We also recognize that sometimes people may have a bad day, or be unaware of some of the guidelines in this Code of Conduct. Please keep this in mind when deciding on how to respond to a breach of this Code.
98+
We know that it is painfully common for internet communication to start at
99+
or devolve into obvious and flagrant abuse. We also recognize that sometimes
100+
people may have a bad day, or be unaware of some of the guidelines in this
101+
Code of Conduct. Please keep this in mind when deciding on how to respond
102+
to a breach of this Code.
51103

52-
For clearly intentional breaches, report those to the Code of Conduct committee (see below). For possibly unintentional breaches, you may reply to the person and point out this code of conduct (either in public or in private, whatever is most appropriate). If you would prefer not to do that, please feel free to report to the Code of Conduct Committee directly, or ask the Committee for advice, in confidence.
104+
For clearly intentional breaches, report those to the Code of Conduct committee
105+
(see below). For possibly unintentional breaches, you may reply to the person
106+
and point out this code of conduct (either in public or in private, whatever
107+
is most appropriate). If you would prefer not to do that, please feel free to
108+
report to the Code of Conduct Committee directly, or ask the Committee
109+
for advice, in confidence.
53110

54-
You can report issues to the napari Code of Conduct committee, at [email protected] . Currently, the committee consists of:
111+
You can report issues to the napari Code of Conduct committee,
112+
at [email protected] . Currently, the committee consists of:
55113

56-
* [Juan Nunez-Iglesias](https://github.com/jni) (chair)
57-
* [Nicholas Sofroniew](https://github.com/sofroniewn)
58-
* [Kira Evans](https://github.com/kne42)
114+
- [Juan Nunez-Iglesias](https://github.com/jni) (chair)
115+
- [Nicholas Sofroniew](https://github.com/sofroniewn)
116+
- [Kira Evans](https://github.com/kne42)
59117

60-
If your report involves any members of the committee, or if they feel they have a conflict of interest in handling it, then they will recuse themselves from considering your report. Alternatively, if for any reason you feel uncomfortable making a report to the committee, then you can also contact:
118+
If your report involves any members of the committee, or if they feel they have
119+
a conflict of interest in handling it, then they will recuse themselves from
120+
considering your report. Alternatively, if for any reason you feel
121+
uncomfortable making a report to the committee, then you can also contact:
61122

62-
* [Charlotte Weaver](https://github.com/csweaver) at [email protected]
123+
- [Charlotte Weaver](https://github.com/csweaver) at [email protected]
63124

64125
## Incident reporting resolution & Code of Conduct enforcement
65126

66-
*This section summarizes the most important points, more details can be found in [napari Code of Conduct - How to follow up on a report.](coc-reporting)*
127+
*This section summarizes the most important points, more details can be found
128+
in [napari Code of Conduct - How to follow up on a report.](coc-reporting)*
67129

68-
We will investigate and respond to all complaints. The napari Code of Conduct Committee will protect the identity of the reporter, and treat the content of complaints as confidential (unless the reporter agrees otherwise).
130+
We will investigate and respond to all complaints. The napari Code of Conduct
131+
Committee will protect the identity of the reporter, and treat the content of
132+
complaints as confidential (unless the reporter agrees otherwise).
69133

70-
In case of severe and obvious breaches, e.g. personal threat or violent, sexist or racist language, we will immediately disconnect the originator from napari communication channels; please see the manual for details.
134+
In case of severe and obvious breaches, e.g. personal threat or violent,
135+
sexist or racist language, we will immediately disconnect the originator
136+
from napari communication channels; please see the manual for details.
71137

72-
In cases not involving clear severe and obvious breaches of this code of conduct, the process for acting on any received code of conduct violation report will be:
138+
In cases not involving clear severe and obvious breaches of this code of
139+
conduct, the process for acting on any received code of conduct violation
140+
report will be:
73141

74142
1. acknowledge report is received
75143

76144
2. reasonable discussion/feedback
77145

78-
3. mediation (if feedback didn’t help, and only if both reporter and reportee agree to this)
146+
3. mediation (if feedback didn’t help, and only if both reporter and
147+
reportee agree to this)
79148

80-
4. enforcement via transparent decision (see [Resolutions](code_of_conduct_reporting.md#resolutions)) by the Code of Conduct Committee
149+
4. enforcement via transparent decision
150+
(see [Resolutions](code_of_conduct_reporting.md#resolutions))
151+
by the Code of Conduct Committee
81152

82-
The committee will respond to any report as soon as possible, and at most within 72 hours.
153+
The committee will respond to any report as soon as possible,
154+
and at most within 72 hours.
83155

84156
## Endnotes
85157

86-
We are thankful to the groups behind the following documents, from which we drew content and inspiration:
158+
We are thankful to the groups behind the following documents,
159+
from which we drew content and inspiration:
87160

88-
* [The SciPy Code of Conduct](https://docs.scipy.org/doc/scipy/dev/conduct/code_of_conduct.html)
89-
* [The Numpy Code of Conduct](https://numpy.org/code-of-conduct/)
161+
- [The SciPy Code of Conduct](https://docs.scipy.org/doc/scipy/dev/conduct/code_of_conduct.html)
162+
- [The Numpy Code of Conduct](https://numpy.org/code-of-conduct/)

0 commit comments

Comments
 (0)