Skip to content

Commit 31a63f0

Browse files
committed
Add contrinuting details.
1 parent 6194c0d commit 31a63f0

File tree

1 file changed

+99
-0
lines changed

1 file changed

+99
-0
lines changed

CONTRIBUTING.md

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
email, or any other method with the owners of this repository before making a change.
5+
6+
Please note we have a code of conduct, please follow it in all your interactions with the project.
7+
8+
## Pull Request Process
9+
10+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
11+
build.
12+
2. This project uses flake8 to conform with common Python standards. Makse sure
13+
to run your code through linter using latest version of flake8, before pull request.
14+
3. Bad documnentation is a Bug. If your change demands documentation update, please do so. If you
15+
find an issue with documentation, take the time to improve or fix it.
16+
4. pytest is used for automated testing. Please make sure to update tests are needed, and to run
17+
`make test`, before submitting your pull request. This should prevent issues with TravisCI and
18+
make the review and merging process easier and faster.
19+
5. Update the README.md with details of changes to the interface, this includes new environment
20+
variables, exposed ports, useful file locations and container parameters.
21+
6. Increase the version numbers in any examples files and the README.md to the new version that this
22+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
23+
7. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
24+
do not have permission to do that, you may request the second reviewer to merge it for you.
25+
26+
## Code of Conduct
27+
28+
### Our Pledge
29+
30+
In the interest of fostering an open and welcoming environment, we as
31+
contributors and maintainers pledge to making participation in our project and
32+
our community a harassment-free experience for everyone, regardless of age, body
33+
size, disability, ethnicity, gender identity and expression, level of experience,
34+
nationality, personal appearance, race, religion, or sexual identity and
35+
orientation.
36+
37+
### Our Standards
38+
39+
Examples of behavior that contributes to creating a positive environment
40+
include:
41+
42+
* Using welcoming and inclusive language
43+
* Being respectful of differing viewpoints and experiences
44+
* Gracefully accepting constructive criticism
45+
* Focusing on what is best for the community
46+
* Showing empathy towards other community members
47+
48+
Examples of unacceptable behavior by participants include:
49+
50+
* The use of sexualized language or imagery and unwelcome sexual attention or
51+
advances
52+
* Trolling, insulting/derogatory comments, and personal or political attacks
53+
* Public or private harassment
54+
* Publishing others' private information, such as a physical or electronic
55+
address, without explicit permission
56+
* Other conduct which could reasonably be considered inappropriate in a
57+
professional setting
58+
59+
### Our Responsibilities
60+
61+
Project maintainers are responsible for clarifying the standards of acceptable
62+
behavior and are expected to take appropriate and fair corrective action in
63+
response to any instances of unacceptable behavior.
64+
65+
Project maintainers have the right and responsibility to remove, edit, or
66+
reject comments, commits, code, wiki edits, issues, and other contributions
67+
that are not aligned to this Code of Conduct, or to ban temporarily or
68+
permanently any contributor for other behaviors that they deem inappropriate,
69+
threatening, offensive, or harmful.
70+
71+
### Scope
72+
73+
This Code of Conduct applies both within project spaces and in public spaces
74+
when an individual is representing the project or its community. Examples of
75+
representing a project or community include using an official project e-mail
76+
address, posting via an official social media account, or acting as an appointed
77+
representative at an online or offline event. Representation of a project may be
78+
further defined and clarified by project maintainers.
79+
80+
### Enforcement
81+
82+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
83+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
84+
complaints will be reviewed and investigated and will result in a response that
85+
is deemed necessary and appropriate to the circumstances. The project team is
86+
obligated to maintain confidentiality with regard to the reporter of an incident.
87+
Further details of specific enforcement policies may be posted separately.
88+
89+
Project maintainers who do not follow or enforce the Code of Conduct in good
90+
faith may face temporary or permanent repercussions as determined by other
91+
members of the project's leadership.
92+
93+
### Attribution
94+
95+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
96+
available at [http://contributor-covenant.org/version/1/4][version]
97+
98+
[homepage]: http://contributor-covenant.org
99+
[version]: http://contributor-covenant.org/version/1/4/

0 commit comments

Comments
 (0)