Skip to content

Commit 6a46c36

Browse files
authored
Create CONTRIBUTING.md
1 parent b7716c2 commit 6a46c36

File tree

1 file changed

+91
-0
lines changed

1 file changed

+91
-0
lines changed

CONTRIBUTING.md

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

0 commit comments

Comments
 (0)