-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Create CODE_of_CONDUCT.rst and CONTRIBUTING.rst
- Loading branch information
Showing
3 changed files
with
129 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,44 @@ | ||
# Contributor Covenant 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, level of experience, nationality, personal appearance, race, religion. | ||
|
||
## 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 | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* 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 [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems 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][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version] | ||
|
||
[homepage]: http://contributor-covenant.org | ||
[version]: http://contributor-covenant.org/version/1/4/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,84 @@ | ||
Contributing code to this project | ||
================================= | ||
|
||
Everyone is welcome to contribute code to this project | ||
(https://github.com/slipeer/synapse-ldap-passwoed-provider), provided that they are willing to license | ||
their contributions under the same license as the project itself. We follow a | ||
simple 'inbound=outbound' model for contributions: the act of submitting an | ||
'inbound' contribution means that the contributor agrees to license the code | ||
under the same terms as the project's overall 'outbound' license - in our | ||
case, this is almost always Apache Software License v2 (see LICENSE). | ||
|
||
How to contribute | ||
----------------- | ||
|
||
The preferred and easiest way to contribute changes to this project is to fork | ||
project on github, and then create a pull request to ask us to pull | ||
your changes into main repo | ||
(https://help.github.com/articles/using-pull-requests/) | ||
|
||
|
||
Code style | ||
---------- | ||
|
||
|
||
Project use PEP8 coding conventions. | ||
Code should pass pep8 --max-line-length=90 without any warnings. | ||
|
||
Sign off | ||
-------- | ||
|
||
In order to have a concrete record that your contribution is intentional | ||
and you agree to license it under the same terms as the project's license, we've adopted the | ||
same lightweight approach that the Linux Kernel | ||
(https://www.kernel.org/doc/Documentation/SubmittingPatches), Docker | ||
(https://github.com/docker/docker/blob/master/CONTRIBUTING.md), and many other | ||
projects use: the DCO (Developer Certificate of Origin: | ||
http://developercertificate.org/). This is a simple declaration that you wrote | ||
the contribution or otherwise have the right to contribute it to this project:: | ||
|
||
Developer Certificate of Origin | ||
Version 1.1 | ||
|
||
Copyright (C) 2004, 2006 The Linux Foundation and its contributors. | ||
660 York Street, Suite 102, | ||
San Francisco, CA 94110 USA | ||
|
||
Everyone is permitted to copy and distribute verbatim copies of this | ||
license document, but changing it is not allowed. | ||
|
||
Developer's Certificate of Origin 1.1 | ||
|
||
By making a contribution to this project, I certify that: | ||
|
||
(a) The contribution was created in whole or in part by me and I | ||
have the right to submit it under the open source license | ||
indicated in the file; or | ||
|
||
(b) The contribution is based upon previous work that, to the best | ||
of my knowledge, is covered under an appropriate open source | ||
license and I have the right under that license to submit that | ||
work with modifications, whether created in whole or in part | ||
by me, under the same open source license (unless I am | ||
permitted to submit under a different license), as indicated | ||
in the file; or | ||
|
||
(c) The contribution was provided directly to me by some other | ||
person who certified (a), (b) or (c) and I have not modified | ||
it. | ||
|
||
(d) I understand and agree that this project and the contribution | ||
are public and that a record of the contribution (including all | ||
personal information I submit with it, including my sign-off) is | ||
maintained indefinitely and may be redistributed consistent with | ||
this project or the open source license(s) involved. | ||
If you agree to this for your contribution, then all that's needed is to | ||
include the line in your commit or pull request comment:: | ||
|
||
Signed-off-by: Your Name <[email protected]> | ||
...using your real name; unfortunately pseudonyms and anonymous contributions | ||
can't be accepted. Git makes this trivial - just use the -s flag when you do | ||
``git commit``, having first set ``user.name`` and ``user.email`` git configs | ||
(which you should have done anyway :) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,6 @@ | ||
include *.in | ||
include *.py | ||
include *.rst | ||
include LICENSE | ||
include tox.ini | ||
include requirements.txt | ||
|