Skip to content

Commit f160cee

Browse files
committed
Add CONTRIBUTING.md
1 parent a7686cc commit f160cee

File tree

2 files changed

+97
-2
lines changed

2 files changed

+97
-2
lines changed

CONTRIBUTING.md

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
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+
## Code of Conduct
20+
21+
### Our Pledge
22+
23+
We as members, contributors, and leaders pledge to make participation in our
24+
community a harassment-free experience for everyone, regardless of age, body
25+
size, visible or invisible disability, ethnicity, sex characteristics, gender
26+
identity and expression, level of experience, education, socio-economic status,
27+
nationality, personal appearance, race, religion, or sexual identity
28+
and orientation.
29+
30+
We pledge to act and interact in ways that contribute to an open, welcoming,
31+
diverse, inclusive, and healthy community.
32+
33+
### Our Standards
34+
35+
Examples of behavior that contributes to a positive environment for our
36+
community include:
37+
38+
* Demonstrating empathy and kindness toward other people
39+
* Being respectful of differing opinions, viewpoints, and experiences
40+
* Giving and gracefully accepting constructive feedback
41+
* Accepting responsibility and apologizing to those affected by our mistakes,
42+
and learning from the experience
43+
* Focusing on what is best not just for us as individuals, but for the
44+
overall community
45+
46+
Examples of unacceptable behavior include:
47+
48+
* The use of sexualized language or imagery, and sexual attention or
49+
advances of any kind
50+
* Trolling, insulting or derogatory comments, and personal or political attacks
51+
* Public or private harassment
52+
* Publishing others' private information, such as a physical or email
53+
address, without their explicit permission
54+
* Other conduct which could reasonably be considered inappropriate in a
55+
professional setting
56+
57+
### Enforcement Responsibilities
58+
59+
Community leaders are responsible for clarifying and enforcing our standards of
60+
acceptable behavior and will take appropriate and fair corrective action in
61+
response to any behavior that they deem inappropriate, threatening, offensive,
62+
or harmful.
63+
64+
Community leaders have the right and responsibility to remove, edit, or reject
65+
comments, commits, code, wiki edits, issues, and other contributions that are
66+
not aligned to this Code of Conduct, and will communicate reasons for moderation
67+
decisions when appropriate.
68+
69+
### Scope
70+
71+
This Code of Conduct applies within all community spaces, and also applies when
72+
an individual is officially representing the community in public spaces.
73+
Examples of representing our community include using an official e-mail address,
74+
posting via an official social media account, or acting as an appointed
75+
representative at an online or offline event.
76+
77+
### Enforcement
78+
79+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
80+
reported to the community leaders responsible for enforcement at
81+
[INSERT CONTACT METHOD].
82+
All complaints will be reviewed and investigated promptly and fairly.
83+
84+
All community leaders are obligated to respect the privacy and security of the
85+
reporter of any incident.
86+
87+
### Attribution
88+
89+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
90+
available at [http://contributor-covenant.org/version/2/0][version]
91+
92+
[homepage]: http://contributor-covenant.org
93+
[version]: http://contributor-covenant.org/version/2/0/

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,12 +123,14 @@ in this repository. The CML interface is the same as `cxxdt-cmake-lint`.
123123

124124
## GitHub tools
125125

126-
### GitHub hooks
127-
128126
- [pre-commit hook](git/.githooks/pre-commit) - Checks
129127
that your `.circleci/config.yml` is valid, otherwise `git commit` fails.
130128

131129
## Continuous Integration
132130

133131
An example of integration of `cxx-dev-tools` into a CI configuration is
134132
available in `.circleci/config.yml`.
133+
134+
## Contributing change
135+
136+
Please read the CONTRIBUTING.md for details on how to contribute to this project.

0 commit comments

Comments
 (0)