Skip to content

Commit 994652a

Browse files
authored
Create CONTRIBUTING.md
1 parent 3b33146 commit 994652a

File tree

1 file changed

+89
-0
lines changed

1 file changed

+89
-0
lines changed

CONTRIBUTING.md

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
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. Ensure that the code is adhering to the existing code style.
15+
16+
## Code of Conduct
17+
18+
### Our Pledge
19+
20+
In the interest of fostering an open and welcoming environment, we as
21+
contributors and maintainers pledge to making participation in our project and
22+
our community a harassment-free experience for everyone, regardless of age, body
23+
size, disability, ethnicity, gender identity and expression, level of experience,
24+
nationality, personal appearance, race, religion, or sexual identity and
25+
orientation.
26+
27+
### Our Standards
28+
29+
Examples of behavior that contributes to creating a positive environment
30+
include:
31+
32+
* Using welcoming and inclusive language
33+
* Being respectful of differing viewpoints and experiences
34+
* Gracefully accepting constructive criticism
35+
* Focusing on what is best for the community
36+
* Showing empathy towards other community members
37+
38+
Examples of unacceptable behavior by participants include:
39+
40+
* The use of sexualized language or imagery and unwelcome sexual attention or
41+
advances
42+
* Trolling, insulting/derogatory comments, and personal or political attacks
43+
* Public or private harassment
44+
* Publishing others' private information, such as a physical or electronic
45+
address, without explicit permission
46+
* Other conduct which could reasonably be considered inappropriate in a
47+
professional setting
48+
49+
### Our Responsibilities
50+
51+
Project maintainers are responsible for clarifying the standards of acceptable
52+
behavior and are expected to take appropriate and fair corrective action in
53+
response to any instances of unacceptable behavior.
54+
55+
Project maintainers have the right and responsibility to remove, edit, or
56+
reject comments, commits, code, wiki edits, issues, and other contributions
57+
that are not aligned to this Code of Conduct, or to ban temporarily or
58+
permanently any contributor for other behaviors that they deem inappropriate,
59+
threatening, offensive, or harmful.
60+
61+
### Scope
62+
63+
This Code of Conduct applies both within project spaces and in public spaces
64+
when an individual is representing the project or its community. Examples of
65+
representing a project or community include using an official project e-mail
66+
address, posting via an official social media account, or acting as an appointed
67+
representative at an online or offline event. Representation of a project may be
68+
further defined and clarified by project maintainers.
69+
70+
### Enforcement
71+
72+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
73+
reported by contacting the project team at [email protected]. All
74+
complaints will be reviewed and investigated and will result in a response that
75+
is deemed necessary and appropriate to the circumstances. The project team is
76+
obligated to maintain confidentiality with regard to the reporter of an incident.
77+
Further details of specific enforcement policies may be posted separately.
78+
79+
Project maintainers who do not follow or enforce the Code of Conduct in good
80+
faith may face temporary or permanent repercussions as determined by other
81+
members of the project's leadership.
82+
83+
### Attribution
84+
85+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
86+
available at [http://contributor-covenant.org/version/1/4][version]
87+
88+
[homepage]: http://contributor-covenant.org
89+
[version]: http://contributor-covenant.org/version/1/4/

0 commit comments

Comments
 (0)