|
| 1 | +.. _contributing: |
| 2 | + |
| 3 | +============== |
| 4 | + Contributing |
| 5 | +============== |
| 6 | + |
| 7 | +Welcome! |
| 8 | + |
| 9 | +This document is fairly extensive and you aren't really expected |
| 10 | +to study this in detail for small contributions; |
| 11 | + |
| 12 | + The most important rule is that contributing must be easy |
| 13 | + and that the community is friendly and not nitpicking on details, |
| 14 | + such as coding style. |
| 15 | + |
| 16 | +.. contents:: |
| 17 | + :local: |
| 18 | + |
| 19 | +.. _community-code-of-conduct: |
| 20 | + |
| 21 | +Community Code of Conduct |
| 22 | +========================= |
| 23 | + |
| 24 | +The goal is to maintain a diverse community that's pleasant for everyone. |
| 25 | +That's why we would greatly appreciate it if everyone contributing to and |
| 26 | +interacting with the community also followed this Code of Conduct. |
| 27 | + |
| 28 | +The Code of Conduct covers our behavior as members of the community, |
| 29 | +in any forum, mailing list, wiki, website, Internet relay chat (IRC), public |
| 30 | +meeting or private correspondence. |
| 31 | + |
| 32 | +The Code of Conduct is heavily based on the `Ubuntu Code of Conduct`_, and |
| 33 | +the `Pylons Code of Conduct`_. |
| 34 | + |
| 35 | +.. _`Ubuntu Code of Conduct`: https://www.ubuntu.com/community/conduct |
| 36 | +.. _`Pylons Code of Conduct`: https://pylonsproject.org/community-code-of-conduct.html |
| 37 | + |
| 38 | +Be considerate |
| 39 | +-------------- |
| 40 | + |
| 41 | +Your work will be used by other people, and you in turn will depend on the |
| 42 | +work of others. Any decision you take will affect users and colleagues, and |
| 43 | +we expect you to take those consequences into account when making decisions. |
| 44 | +Even if it's not obvious at the time, our contributions to Pytest Celery will |
| 45 | +impact the work of others. For example, changes to code, infrastructure, policy, |
| 46 | +documentation and translations during a release may negatively impact others' work. |
| 47 | + |
| 48 | +Be respectful |
| 49 | +------------- |
| 50 | + |
| 51 | +The Celery community and its members treat one another with respect. Everyone |
| 52 | +can make a valuable contribution to Celery. We may not always agree, but |
| 53 | +disagreement is no excuse for poor behavior and poor manners. We might all |
| 54 | +experience some frustration now and then, but we cannot allow that frustration |
| 55 | +to turn into a personal attack. It's important to remember that a community |
| 56 | +where people feel uncomfortable or threatened isn't a productive one. We |
| 57 | +expect members of the Celery community to be respectful when dealing with |
| 58 | +other contributors as well as with people outside the Celery project and with |
| 59 | +users of Celery. |
| 60 | + |
| 61 | +Be collaborative |
| 62 | +---------------- |
| 63 | + |
| 64 | +Collaboration is central to Pytest Celery and to the larger free software community. |
| 65 | +We should always be open to collaboration. Your work should be done |
| 66 | +transparently and patches from Pytest Celery should be given back to the community |
| 67 | +when they're made, not just when the distribution releases. If you wish |
| 68 | +to work on new code for existing upstream projects, at least keep those |
| 69 | +projects informed of your ideas and progress. It many not be possible to |
| 70 | +get consensus from upstream, or even from your colleagues about the correct |
| 71 | +implementation for an idea, so don't feel obliged to have that agreement |
| 72 | +before you begin, but at least keep the outside world informed of your work, |
| 73 | +and publish your work in a way that allows outsiders to test, discuss, and |
| 74 | +contribute to your efforts. |
| 75 | + |
| 76 | +When you disagree, consult others |
| 77 | +--------------------------------- |
| 78 | + |
| 79 | +Disagreements, both political and technical, happen all the time and |
| 80 | +the Celery community is no exception. It's important that we resolve |
| 81 | +disagreements and differing views constructively and with the help of the |
| 82 | +community and community process. If you really want to go a different |
| 83 | +way, then we encourage you to make a derivative distribution or alternate |
| 84 | +set of packages that still build on the work we've done to utilize as common |
| 85 | +of a core as possible. |
| 86 | + |
| 87 | +When you're unsure, ask for help |
| 88 | +-------------------------------- |
| 89 | + |
| 90 | +Nobody knows everything, and nobody is expected to be perfect. Asking |
| 91 | +questions avoids many problems down the road, and so questions are |
| 92 | +encouraged. Those who are asked questions should be responsive and helpful. |
| 93 | +However, when asking a question, care must be taken to do so in an appropriate |
| 94 | +forum. |
| 95 | + |
| 96 | +Step down considerately |
| 97 | +----------------------- |
| 98 | + |
| 99 | +Developers on every project come and go and Celery is no different. When you |
| 100 | +leave or disengage from the project, in whole or in part, we ask that you do |
| 101 | +so in a way that minimizes disruption to the project. This means you should |
| 102 | +tell people you're leaving and take the proper steps to ensure that others |
| 103 | +can pick up where you left off. |
| 104 | + |
| 105 | +.. _git-tags: |
| 106 | + |
| 107 | +Tags |
| 108 | +==== |
| 109 | + |
| 110 | +- Tags are used exclusively for tagging releases. A release tag is |
| 111 | + named with the format ``vX.Y.Z`` -- for example ``v1.2.3``. |
| 112 | + |
| 113 | +- Experimental releases contain an additional identifier ``vX.Y.Zid`` -- |
| 114 | + for example ``v1.2.3rc1``. |
| 115 | + |
| 116 | +- Experimental tags may be removed after the official release. |
| 117 | + |
| 118 | +.. _contact_information: |
| 119 | + |
| 120 | +Contacts |
| 121 | +======== |
| 122 | + |
| 123 | +This is a list of people that can be contacted for questions |
| 124 | +regarding the official git repositories, PyPI packages |
| 125 | +Read the Docs pages. |
| 126 | + |
| 127 | +If the issue isn't an emergency then it's better |
| 128 | +to report an issue. |
| 129 | + |
| 130 | +Committers |
| 131 | +---------- |
| 132 | + |
| 133 | +Tomer Nosrati |
| 134 | +~~~~~~~~~~~~~ |
| 135 | + |
| 136 | +:web: http://tomernosrati.com/ |
| 137 | +:github: https://github.com/Nusnus |
| 138 | +:twitter: https://x.com/tomer_nosrati |
0 commit comments