Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
add CONTRIBUTING.md and CODE_OF_CONDUCT.md
- Loading branch information
Showing
2 changed files
with
57 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 Code of Conduct | ||
|
||
#### Guidelines | ||
|
||
* Please be respectful to one another. | ||
* Many contributors are volunteering their time. We might not get to your | ||
issue right away. Be patient. | ||
* Other contributors have different backgrounds and perspectives than you do. | ||
Diversity is a community strength. | ||
* We will disagree sometimes. That's ok. When this happens, assume that the | ||
person with whom you disagree is a smart person with good reasons for believing | ||
something different. | ||
* Everyone has bad days. If you find yourself about to be mean to someone, | ||
take a break and cool off. This project will still be here later. | ||
* When you make a mistake, apologize. | ||
|
||
|
||
#### We will not tolerate | ||
|
||
* Sexualized language or imagery | ||
* Hate speech | ||
* Personal attacks | ||
* Trolling or insulting/derogatory comments | ||
* Public or private harassment | ||
* Publishing other's private information | ||
* Plagiarism | ||
* Other unethical or unprofessional conduct | ||
|
||
#### Enforcement | ||
|
||
Project maintainers commit themselves to fairly enforcing this Code of Conduct. | ||
This means we may: | ||
|
||
* Edit or delete harmful comments, code, issues, or other contributions | ||
* Ban harmful users from the project, temporarily or permanently | ||
|
||
This Code of Conduct applies both within project spaces and in public spaces when an | ||
individual is representing the project or its community. | ||
|
||
Instances of unacceptable behavior may be reported privately to the project maintainers. | ||
|
||
#### See Also | ||
|
||
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org). |
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,13 @@ | ||
### Contributing to this project | ||
|
||
We welcome all contributions. Before submitting an issue, please read through currently open issues as well as the [Project Roadmap](ROADMAP.md). Please note this is a work in progress, however we have attempted to document the limitations and caveats in the Roadmap and currently open issues. | ||
|
||
We also ask that you be respectful in tone and language, and under no circumstances make inferences based on people's gender, race, nationality, etc. Please take a moment to read our [Code of Conduct](CODE_OF_CONDUCT.md). | ||
|
||
### Making Pull Requests | ||
|
||
Even better than filing issues is making a Pull Request to fix something! We encourage you to try and fix things yourself and make Pull Requests, and we commit to being responsive and helpful while reviewing. When making a Pull Request, please make it against the `develop` branch in this repository. Where possible, please follow existing coding style practices - the only hard rule being please use spaces and not tabs for indentation, and the YAML files use 2 spaces for indents. | ||
|
||
### Community | ||
|
||
We are committed to running this as a community project, and highly encourage any involvement. Please reach out if you feel there's anything we can do to make this a more welcoming space for contributions - we really hope to collaborate with you to grow out this project! |