Add code of conduct to documentation

README.md

@@ -28,6 +28,8 @@ Shortcuts:
 - [Usage](https://phys2bids.readthedocs.io/en/latest/cli.html)
 - [Contributing to phys2bids](https://phys2bids.readthedocs.io/en/latest/contributing.html)
 - [Developer installation](https://phys2bids.readthedocs.io/en/latest/contributing.html#linux-and-mac-developer-installation)
+- [**Contributor guide**](https://phys2bids.readthedocs.io/en/latest/contributorfile.html)
+- [**Code of Conduct**](https://phys2bids.readthedocs.io/en/latest/conduct.html)
 
 **The project is currently under development**.
 Any suggestion/bug report is welcome! Feel free to open an issue.

docs/conduct.rst

@@ -0,0 +1,154 @@
+.. _conduct:
+
+Physiopy Code of Conduct
+=========================
+
+*Based on the* |covenant|_.
+
+.. _covenant: https://www.contributor-covenant.org/
+
+.. |covenant| replace:: *Contributor Covenant Code of Conduct*
+
+Our Pledge
+----------
+
+We as members, contributors, and leaders pledge to make participation in
+our community a harassment-free experience for everyone, regardless of
+age, body size, visible or invisible disability, ethnicity, sex
+characteristics, gender identity and expression, level of experience,
+education, socio-economic status, nationality, personal appearance,
+race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open,
+welcoming, diverse, inclusive, and healthy community.
+
+Our Standards
+-------------
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+-  Demonstrating empathy and kindness toward other people
+-  Being respectful of differing opinions, viewpoints, and experiences
+-  Giving and gracefully accepting constructive feedback
+-  Accepting responsibility and apologizing to those affected by our
+   mistakes, and learning from the experience
+-  Focusing on what is best not just for us as individuals, but for the
+   overall community
+
+Examples of unacceptable behavior include:
+
+-  The use of sexualized language or imagery, and sexual attention or
+   advances of any kind
+-  Trolling, insulting or derogatory comments, and personal or political
+   attacks
+-  Public or private harassment
+-  Publishing others' private information, such as a physical or email
+   address, without their explicit permission
+-  Other conduct which could reasonably be considered inappropriate in a
+   professional setting
+
+Enforcement Responsibilities
+----------------------------
+
+Community leaders are responsible for clarifying and enforcing our
+standards of acceptable behavior and will take appropriate and fair
+corrective action in response to any behavior that they deem
+inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other
+contributions that are not aligned to this Code of Conduct, and will
+communicate reasons for moderation decisions when appropriate.
+
+Scope
+-----
+
+This Code of Conduct applies within all community spaces, and also
+applies when an individual is officially representing the community in
+public spaces. Examples of representing our community include using an
+official e-mail address, posting via an official social media account,
+creating and diffusing outreaching material (e.g. abstracts, posters,
+papers, demonstrations, ...), or acting as an appointed representative
+at an online or offline event.
+
+Enforcement
+-----------
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may
+be reported to the community leaders responsible for enforcement at
+s.moia@bcbl.eu. All complaints will be reviewed and investigated
+promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security
+of the reporter of any incident.
+
+Enforcement Guidelines
+----------------------
+
+Community leaders will follow these Community Impact Guidelines in
+determining the consequences for any action they deem in violation of
+this Code of Conduct:
+
+1. Correction
+~~~~~~~~~~~~~
+
+**Community Impact**: Use of inappropriate language or other behavior
+deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders,
+providing clarity around the nature of the violation and an explanation
+of why the behavior was inappropriate. A public apology may be
+requested.
+
+2. Warning
+~~~~~~~~~~
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, for a specified period of
+time. This includes avoiding interactions in community spaces as well as
+external channels like social media. Violating these terms may lead to a
+temporary or permanent ban.
+
+3. Temporary Ban
+~~~~~~~~~~~~~~~~
+
+**Community Impact**: A serious violation of community standards,
+including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No
+public or private interaction with the people involved, including
+unsolicited interaction with those enforcing the Code of Conduct, is
+allowed during this period. Violating these terms may lead to a
+permanent ban.
+
+4. Permanent Ban
+~~~~~~~~~~~~~~~~
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of
+individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction
+within the project community.
+
+Attribution
+-----------
+
+This Code of Conduct is adapted from the `Contributor
+Covenant <https://www.contributor-covenant.org>`_, version 2.0,
+available at
+https://www.contributor-covenant.org/version/2/0/code\_of\_conduct.html.
+
+Community Impact Guidelines were inspired by `Mozilla's code of conduct
+enforcement ladder <https://github.com/mozilla/diversity>`_.
+
+For answers to common questions about this code of conduct, see the FAQ
+at https://www.contributor-covenant.org/faq. Translations are available
+at https://www.contributor-covenant.org/translations.

docs/contributing.rst

@@ -1,15 +1,15 @@
 .. _contributing:
 
 =============================
-Contributing to ``phys2bids``
+Contributing to ``physiopy``
 =============================
 
 First of all: thank you!
 
 Contributions can be made in different ways, not only code!
 As we follow the `all-contributors`_ specification, any contribution will be recognised accordingly.
 
-The first thing you might want to do, is having a look at the `contributor guide <contributorfile.html>`_ page as well as the ``conduct.md`` guidelines.
+The first thing you might want to do, is having a look at the `contributor guide <contributorfile.html>`_ page as well as the `code of conduct <conduct.html>`_.
 
 The second thing is to install ``phys2bids`` as a developer.
 This will let you run the program with the latest modification, without requiring to re-install it every time.

docs/contributorfile.rst

@@ -12,18 +12,18 @@ Already know what you're looking for in this guide? Jump to the following sectio
 
 - `Aims of physiopy <#aims>`_
 - `Join the conversation <#joinconvo>`_
-- `Contributions <#contributions>`_
- - `Contributing with small documentation changes <#smalldocs>`_
- - `Contributing with User testing <#usertests>`_
- - `Contributing with test files <#testfile>`_
- - `Contributing documentation through GitHub <#documenting>`_
- - `Contributing code through GitHub <#code>`_
-- `Issues and Milestones <#issues>`_
-- `Labels <#labels>`_
- - `Issues labels <#issuelabel>`_
- - `PRs labels <#prlabel>`_
- - `Issues & PRs labels <#issueprlabels>`_
- - `Good First Issues <#g1i>`_
+- `Contributions <#contributiontypes>`_
+   - `Contributing with small documentation changes <#smalldocs>`_
+   - `Contributing with User testing <#usertests>`_
+   - `Contributing with test files <#testfile>`_
+   - `Contributing documentation through GitHub <#documenting>`_
+   - `Contributing code through GitHub <#code>`_
+- `Issues and Milestones <#issuesmilestones>`_
+- `Labels <#labeltypes>`_
+   - `Issues labels <#issuelabel>`_
+   - `PRs labels <#prlabel>`_
+   - `Issues & PRs labels <#issueprlabels>`_
+   - `Good First Issues <#g1i>`_
 - `Contribution workflow <#workflow>`_
 - `Pull Requests <#pr>`_
 - `Style Guide <#styling>`_
@@ -49,9 +49,9 @@ Joining the conversation
 We’re trying to keep all the conversation related to the project development in GitHub `issues <https://github.com/smoia/phys2bids/issues>`_.
 We maintain a `gitter chat room <https://gitter.im/phys2bids/community>`_ for more informal conversations and general project updates.
 We also have a dev call once a month - specifically the second Thursday of the month! If you want to participate, drop a line in gitter!
-When interacting in the common channels, please adhere to our `code of conduct <https://github.com/physiopy/phys2bids/blob/master/Code_of_Conduct.md>`_.
+When interacting in the common channels, please adhere to our `code of conduct <conduct.html>`_.
 
-.. _contributions:
+.. _contributiontypes:
 
 Contributions
 -------------
@@ -101,15 +101,15 @@ The best way to make this kind of contributions, in a nutshell, would be:
 4. Wait for a review, discuss it or comply, repeat until ready.
 Issues and PR chats are great to maintain track of the conversation on the contribution. They are based upon GitHub-flavoured `Markdown <https://daringfireball.net/projects/markdown>`_. GitHub has a helpful page on `getting started with writing and formatting Markdown on GitHub <https://help.github.com/articles/getting-started-with-writing-and-formatting-on-github>`_.
 
-.. _issues:
+.. _issuesmilestones:
 
 Issues and Milestones
 ---------------------
 At physiopy, we use Issues and Milestones to keep track of and organise our workflow.
 - **Issues** describe pieces of work that need to be completed to move the project forwards. We try to keep them as simple and clear as possible: an issue should describe a unitary, possibly small piece of work (unless it’s about refactoring). Don’t be scared of opening many issues at once, if it makes sense! Just check that what you’re proposing is not listed in a previous issue (open or closed) yet - we don’t like doubles. Issues get labelled. That helps the contributors to know what they’re about. Check the label list to know what types are there, and use them accordingly! Issues can also be **assigned**. If you want to work on an assigned issue, ask permission first!
 - **Milestones** set the higher level workflow. They sketch deadlines and important releases. Issues are assigned to these milestones by the maintainers. If you feel that an issue should be assigned to a specific milestone but the maintainers have not done so, discuss it in the issue chat or in Gitter! We might have just missed it, or we might not (yet) see how it aligns with the overall project structure/milestone.
 
-.. _labels:
+.. _labeltypes:
 
 Labels
 ------

docs/index.rst

@@ -34,5 +34,6 @@ Contents
    cli
    contributing
    contributorfile
+   conduct
    license
    api