Skip to content

Commit 9ff929f

Browse files
Add contributing guide
1 parent c94af07 commit 9ff929f

File tree

1 file changed

+88
-0
lines changed

1 file changed

+88
-0
lines changed

contributing.md

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

0 commit comments

Comments
 (0)