Skip to content

Commit a0c962e

Browse files
authored
Create CONTRIBUTING.md
1 parent 2e1ad1a commit a0c962e

File tree

1 file changed

+70
-0
lines changed

1 file changed

+70
-0
lines changed

CONTRIBUTING.md

+70
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
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. Update the README.md with details of changes to the interface, this includes new environment
13+
variables, exposed ports, useful file locations and container parameters.
14+
3. Increase the version numbers in any examples files and the README.md to the new version that this
15+
Pull Request would represent.
16+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
17+
do not have permission to do that, you may request the second reviewer to merge it for you.
18+
19+
## Code of Conduct
20+
21+
### Our Pledge
22+
23+
In the interest of fostering an open and welcoming environment, we as
24+
contributors and maintainers pledge to making participation in our project and
25+
our community a harassment-free experience for everyone, regardless of age, body
26+
size, disability, ethnicity, gender identity and expression, level of experience,
27+
nationality, personal appearance, race, religion, or sexual identity and
28+
orientation.
29+
30+
### Our Responsibilities
31+
32+
Project maintainers are responsible for clarifying the standards of acceptable
33+
behavior and are expected to take appropriate and fair corrective action in
34+
response to any instances of unacceptable behavior.
35+
36+
Project maintainers have the right and responsibility to remove, edit, or
37+
reject comments, commits, code, wiki edits, issues, and other contributions
38+
that are not aligned to this Code of Conduct, or to ban temporarily or
39+
permanently any contributor for other behaviors that they deem inappropriate,
40+
threatening, offensive, or harmful.
41+
42+
### Scope
43+
44+
This Code of Conduct applies both within project spaces and in public spaces
45+
when an individual is representing the project or its community. Examples of
46+
representing a project or community include using an official project e-mail
47+
address, posting via an official social media account, or acting as an appointed
48+
representative at an online or offline event. Representation of a project may be
49+
further defined and clarified by project maintainers.
50+
51+
### Enforcement
52+
53+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
54+
reported by contacting the project team at [email protected]. All
55+
complaints will be reviewed and investigated and will result in a response that
56+
is deemed necessary and appropriate to the circumstances. The project team is
57+
obligated to maintain confidentiality with regard to the reporter of an incident.
58+
Further details of specific enforcement policies may be posted separately.
59+
60+
Project maintainers who do not follow or enforce the Code of Conduct in good
61+
faith may face temporary or permanent repercussions as determined by other
62+
members of the project's leadership.
63+
64+
### Attribution
65+
66+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
67+
available at [http://contributor-covenant.org/version/1/4][version]
68+
69+
[homepage]: http://contributor-covenant.org
70+
[version]: http://contributor-covenant.org/version/1/4/

0 commit comments

Comments
 (0)