Skip to content

Commit b41bbd5

Browse files
This commit adds contributing guidelines and tips
1 parent 4444db0 commit b41bbd5

File tree

1 file changed

+121
-0
lines changed

1 file changed

+121
-0
lines changed

CONTRIBUTING.md

+121
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
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. The versioning scheme we use is [SemVer](http://semver.org/).
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+
Beyond these notes, new contributors may find it helpful to store these commands in a local shell
20+
function or hotkey. They will help you on your journey.
21+
22+
### Running doctests:
23+
24+
```
25+
cargo test --doc
26+
```
27+
28+
### Running all tests:
29+
30+
```
31+
cargo test
32+
```
33+
34+
### Linting with clippy:
35+
36+
```
37+
cargo clippy --all-targets --no-default-features
38+
```
39+
40+
### Pre-Commit:
41+
42+
```
43+
cargo fmt -- --checK
44+
```
45+
If this does not already work in your development environment, you might need to run
46+
`rustup component add rustfmt` and try again.
47+
48+
## Code of Conduct
49+
50+
### Our Pledge
51+
52+
In the interest of fostering an open and welcoming environment, we as
53+
contributors and maintainers pledge to making participation in our project and
54+
our community a harassment-free experience for everyone, regardless of age, body
55+
size, disability, ethnicity, gender identity and expression, level of experience,
56+
nationality, personal appearance, race, religion, or sexual identity and
57+
orientation.
58+
59+
### Our Standards
60+
61+
Examples of behavior that contributes to creating a positive environment
62+
include:
63+
64+
* Using welcoming and inclusive language
65+
* Being respectful of differing viewpoints and experiences
66+
* Gracefully accepting constructive criticism
67+
* Focusing on what is best for the community
68+
* Showing empathy towards other community members
69+
70+
Examples of unacceptable behavior by participants include:
71+
72+
* The use of sexualized language or imagery and unwelcome sexual attention or
73+
advances
74+
* Trolling, insulting/derogatory comments, and personal or political attacks
75+
* Public or private harassment
76+
* Publishing others' private information, such as a physical or electronic
77+
address, without explicit permission
78+
* Other conduct which could reasonably be considered inappropriate in a
79+
professional setting
80+
81+
### Our Responsibilities
82+
83+
Project maintainers are responsible for clarifying the standards of acceptable
84+
behavior and are expected to take appropriate and fair corrective action in
85+
response to any instances of unacceptable behavior.
86+
87+
Project maintainers have the right and responsibility to remove, edit, or
88+
reject comments, commits, code, wiki edits, issues, and other contributions
89+
that are not aligned to this Code of Conduct, or to ban temporarily or
90+
permanently any contributor for other behaviors that they deem inappropriate,
91+
threatening, offensive, or harmful.
92+
93+
### Scope
94+
95+
This Code of Conduct applies both within project spaces and in public spaces
96+
when an individual is representing the project or its community. Examples of
97+
representing a project or community include using an official project e-mail
98+
address, posting via an official social media account, or acting as an appointed
99+
representative at an online or offline event. Representation of a project may be
100+
further defined and clarified by project maintainers.
101+
102+
### Enforcement
103+
104+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
105+
reported by contacting the project team at [INSERT EMAIL ADDRESS]. All
106+
complaints will be reviewed and investigated and will result in a response that
107+
is deemed necessary and appropriate to the circumstances. The project team is
108+
obligated to maintain confidentiality with regard to the reporter of an incident.
109+
Further details of specific enforcement policies may be posted separately.
110+
111+
Project maintainers who do not follow or enforce the Code of Conduct in good
112+
faith may face temporary or permanent repercussions as determined by other
113+
members of the project's leadership.
114+
115+
### Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
118+
available at [http://contributor-covenant.org/version/1/4][version]
119+
120+
[homepage]: http://contributor-covenant.org
121+
[version]: http://contributor-covenant.org/version/1/4/

0 commit comments

Comments
 (0)