UNPKG

4 kBMarkdownView Raw
1# Contributing
2
3When contributing to this repository, please first discuss the change you wish to make via issue,
4email, or any other method with the maintainers of this repository before making a change.
5
6Please note we have a code of conduct, please follow it in all your interactions with the project.
7
8## Pull Request Process
9
101. Ensure any install or build dependencies are removed before submitting a Pull Request.
112. 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.
133. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
14 do not have permission to do that, you may request the second reviewer to merge it for you.
15
16## Code of Conduct
17
18### Our Pledge
19
20In the interest of fostering an open and welcoming environment, we as
21contributors and maintainers pledge to making participation in our project and
22our community a harassment-free experience for everyone, regardless of age, body
23size, disability, ethnicity, gender identity and expression, level of experience,
24nationality, personal appearance, race, religion, or sexual identity and
25orientation.
26
27### Our Standards
28
29Examples of behavior that contributes to creating a positive environment
30include:
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
38Examples of unacceptable behavior by participants include:
39
40* The use of sexualized language or imagery and unwelcome sexual attention or
41advances
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
51Project maintainers are responsible for clarifying the standards of acceptable
52behavior and are expected to take appropriate and fair corrective action in
53response to any instances of unacceptable behavior.
54
55Project maintainers have the right and responsibility to remove, edit, or
56reject comments, commits, code, wiki edits, issues, and other contributions
57that are not aligned to this Code of Conduct, or to ban temporarily or
58permanently any contributor for other behaviors that they deem inappropriate,
59threatening, offensive, or harmful.
60
61### Scope
62
63This Code of Conduct applies both within project spaces and in public spaces
64when an individual is representing the project or its community. Examples of
65representing a project or community include using an official project e-mail
66address, posting via an official social media account, or acting as an appointed
67representative at an online or offline event. Representation of a project may be
68further defined and clarified by project maintainers.
69
70### Enforcement
71
72Instances of abusive, harassing, or otherwise unacceptable behavior may be
73reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
74complaints will be reviewed and investigated and will result in a response that
75is deemed necessary and appropriate to the circumstances. The project team is
76obligated to maintain confidentiality with regard to the reporter of an incident.
77Further details of specific enforcement policies may be posted separately.
78
79Project maintainers who do not follow or enforce the Code of Conduct in good
80faith may face temporary or permanent repercussions as determined by other
81members of the project's leadership.
82
83### Attribution
84
85This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
86available 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/