diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 000000000..4ea1b7116 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,11 @@ +Contributing to pretix +====================== + +Hey there and welcome to pretix! + +We've got an contributors guide in [our documentation](https://docs.pretix.eu/en/latest/development/contribution/) +together with notes on the [development setup](https://docs.pretix.eu/en/latest/development/setup.html). + +Please note that we have a [Code of Conduct](https://docs.pretix.eu/en/latest/development/contribution/codeofconduct.html) +in place that applies to all project contributions, including issues, pull requests, etc. + diff --git a/doc/development/contribution/codeofconduct.rst b/doc/development/contribution/codeofconduct.rst new file mode 100644 index 000000000..2edbcae02 --- /dev/null +++ b/doc/development/contribution/codeofconduct.rst @@ -0,0 +1,82 @@ +.. _`coc`: + +Code of Conduct +=============== + +Our Pledge +---------- + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +Our Standards +------------- + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or + advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +Our Responsibilities +-------------------- + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers 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, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +Scope +----- + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +Enforcement +----------- + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at support@pretix.eu. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +Attribution +----------- + +This Code of Conduct is adapted from the `Contributor Covenant`_, version 1.4, +available at http://contributor-covenant.org/version/1/4/ + +.. _Contributor Covenant: http://contributor-covenant.org diff --git a/doc/development/contribution/general.rst b/doc/development/contribution/general.rst index bcbcf4b0a..8ee6d625d 100644 --- a/doc/development/contribution/general.rst +++ b/doc/development/contribution/general.rst @@ -9,6 +9,8 @@ constructive and friendly feedback on your changes. First of all, you'll need pretix running locally on your machine. Head over to :ref:`devsetup` to learn how to do this. If you run into any problems on your way, please do not hesitate to ask us anytime! +Please note that we have a :ref:`coc` in place that applies to all communication around the project. + Sending a patch --------------- @@ -30,7 +32,6 @@ please include a regression test, i.e. a test that fails without your changes an Again: If you get stuck, do not hesitate to contact any of us, or Raphael personally at mail@raphaelmichel.de. - .. _create a pull request: https://help.github.com/articles/creating-a-pull-request/ .. _GitHub repository: https://github.com/pretix/pretix .. _squash all your changes: https://davidwalsh.name/squash-commits-git \ No newline at end of file diff --git a/doc/development/contribution/index.rst b/doc/development/contribution/index.rst index 0e3f1b14e..a6580bade 100644 --- a/doc/development/contribution/index.rst +++ b/doc/development/contribution/index.rst @@ -6,3 +6,4 @@ Contribution guide general style + codeofconduct