Skip to content

Commit

Permalink
initial reformat
Browse files Browse the repository at this point in the history
  • Loading branch information
@Czaki
Czaki committed Nov 21, 2022
1 parent ac24a78 commit 833ec22
Show file tree
Hide file tree
Showing 7 changed files with 418 additions and 149 deletions.
11 changes: 11 additions & 0 deletions .pre-commit-config.yaml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
repos:
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.16
hooks:
- id: mdformat
exclude: .github|docs/release|EULA.md
- repo: https://github.com/jackdewinter/pymarkdown
rev: v0.9.8
hooks:
- id: pymarkdown
exclude: .github|docs/release|EULA.md
3 changes: 2 additions & 1 deletion docs/api/index.md
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
(api)=

# API Reference

Information on specific functions, classes, and methods.

```{tableofcontents}
```
```
165 changes: 119 additions & 46 deletions docs/community/code_of_conduct.md
View file
Original file line number Diff line number Diff line change
@@ -1,89 +1,162 @@
(napari-coc)=

# Code of Conduct

## Introduction

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.
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.

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.
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.

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.
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.

## Specific guidelines

We strive to:

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.

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.

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.

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.

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:

> * Violent threats or language directed against another person.
> * Sexist, racist, ableist, or otherwise discriminatory jokes and language.
> * Posting sexually explicit or violent material.
> * Posting (or threatening to post) other people’s personally identifying information (“doxing”).
> * Sharing private content, such as emails sent privately or non-publicly, or unlogged forums such as IRC channel history, without the sender’s consent.
> * Personal insults, especially those using sexist, racist, or ableist terms.
> * Intentional or repeated misgendering of participants who have explicitly requested to be addressed by specific pronouns.
> * Unwelcome sexual attention.
> * Excessive profanity. Please avoid swearwords; people differ greatly in their sensitivity to swearing.
> * Repeated harassment of others. In general, if someone asks you to stop, then stop.
> * Advocating for, or encouraging, any of the above behaviour.
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.

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.

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.

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.

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:

> - Violent threats or language directed against another person.
> - Sexist, racist, ableist, or otherwise discriminatory jokes and language.
> - Posting sexually explicit or violent material.
> - Posting (or threatening to post) other people’s personally identifying \
> information (“doxing”).
> - Sharing private content, such as emails sent privately or non-publicly,
> or unlogged forums such as IRC channel history, without the sender’s
> consent.
> - Personal insults, especially those using sexist, racist, or ableist terms.
> - Intentional or repeated misgendering of participants who have explicitly
> requested to be addressed by specific pronouns.
> - Unwelcome sexual attention.
> - Excessive profanity. Please avoid swearwords; people differ greatly in
> their sensitivity to swearing.
> - Repeated harassment of others. In general, if someone asks you to stop,
> then stop.
> - Advocating for, or encouraging, any of the above behaviour.
## Diversity statement

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.
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.

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.
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.

Though we welcome people fluent in all languages, napari development is conducted in English.
Though we welcome people fluent in all languages, napari development is
conducted in English.

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).
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).

## Reporting guidelines

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.
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.

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.
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.

You can report issues to the napari Code of Conduct committee, at [email protected] . Currently, the committee consists of:
You can report issues to the napari Code of Conduct committee,
at [email protected] . Currently, the committee consists of:

* [Juan Nunez-Iglesias](https://github.com/jni) (chair)
* [Nicholas Sofroniew](https://github.com/sofroniewn)
* [Kira Evans](https://github.com/kne42)
- [Juan Nunez-Iglesias](https://github.com/jni) (chair)
- [Nicholas Sofroniew](https://github.com/sofroniewn)
- [Kira Evans](https://github.com/kne42)

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:
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:

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

## Incident reporting resolution & Code of Conduct enforcement

*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)*
*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)*

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).
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).

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.
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.

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:
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:

1. acknowledge report is received

2. reasonable discussion/feedback

3. mediation (if feedback didn’t help, and only if both reporter and reportee agree to this)
3. mediation (if feedback didn’t help, and only if both reporter and
reportee agree to this)

4. enforcement via transparent decision (see [Resolutions](code_of_conduct_reporting.md#resolutions)) by the Code of Conduct Committee
4. enforcement via transparent decision
(see [Resolutions](code_of_conduct_reporting.md#resolutions))
by the Code of Conduct Committee

The committee will respond to any report as soon as possible, and at most within 72 hours.
The committee will respond to any report as soon as possible,
and at most within 72 hours.

## Endnotes

We are thankful to the groups behind the following documents, from which we drew content and inspiration:
We are thankful to the groups behind the following documents,
from which we drew content and inspiration:

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

0 comments on commit 833ec22

Please sign in to comment.