Skip to content

Commit 3e44e2d

Browse files
committed
add code of conduct and contributing documents
1 parent ef815a9 commit 3e44e2d

File tree

2 files changed

+84
-0
lines changed

2 files changed

+84
-0
lines changed

CODE_OF_CONDUCT.md

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
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.
6+
7+
## Our Standards
8+
9+
Examples of behavior that contributes to creating a positive environment include:
10+
11+
* Using welcoming and inclusive language
12+
* Being respectful of differing viewpoints and experiences
13+
* Gracefully accepting constructive criticism
14+
* Focusing on what is best for the community
15+
* Showing empathy towards other community members
16+
17+
Examples of unacceptable behavior by participants include:
18+
19+
* The use of sexualized language or imagery and unwelcome sexual attention or advances
20+
* Trolling, insulting/derogatory comments, and personal or political attacks
21+
* Public or private harassment
22+
* Publishing others' private information, such as a physical or electronic address, without explicit permission
23+
* Other conduct which could reasonably be considered inappropriate in a professional setting
24+
25+
## Our Responsibilities
26+
27+
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.
28+
29+
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.
30+
31+
## Scope
32+
33+
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.
34+
35+
## Enforcement
36+
37+
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.
38+
39+
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.
40+
41+
## Attribution
42+
43+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
44+
45+
[homepage]: http://contributor-covenant.org
46+
[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.rst

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
How to Contribute
2+
=================
3+
4+
Contributions are welcome! Not familiar with the codebase yet? No problem!
5+
There are many ways to contribute to open source projects: reporting bugs,
6+
helping with the documentation, spreading the word and of course, adding
7+
new features and patches.
8+
9+
Getting Started
10+
---------------
11+
#. Make sure you have a GitHub account.
12+
#. Open a `new issue`_, assuming one does not already exist.
13+
#. Clearly describe the issue including steps to reproduce when it is a bug.
14+
15+
Making Changes
16+
--------------
17+
* Fork_ the repository on GitHub.
18+
* Create a topic branch from where you want to base your work.
19+
* This is usually the ``master`` branch.
20+
* Please avoid working directly on ``master`` branch.
21+
* Make commits of logical units (if needed rebase your feature branch before
22+
submitting it).
23+
* Check for unnecessary whitespace with ``git diff --check`` before committing.
24+
* Make sure your commit messages are in the `proper format`_.
25+
* If your commit fixes an open issue, reference it in the commit message (#15).
26+
* Make sure your code comforms to PEP8_.
27+
* Make sure you have added the necessary tests for your changes.
28+
* Run all the tests to assure nothing else was accidentally broken.
29+
* Don't forget to add yourself to AUTHORS_.
30+
31+
These guidelines also apply when helping with documentation (actually, for
32+
typos and minor additions you might choose to `fork and edit`_).
33+
34+
Submitting Changes
35+
------------------
36+
* Push your changes to a topic branch in your fork of the repository.
37+
* Submit a `Pull Request`_.
38+
* Wait for maintainer feedback.

0 commit comments

Comments
 (0)