Skip to content

Commit ebb3545

Browse files
committed
Add CONTRIBUTING.md and CONTRIBUTORS.md files
Added a CONTRIBUTING.md which lays out guidelines and some helpful information to help people who are new to contributing to the project. This also has a slight amendment to the current CoC to help it be relevant in this context as well, as current wording feels more geared to events, rather than contributors to an OSS/F(L)OSS project. Added a CONTRIBUTORS.md file which doubles as an contributor attribution list, and as a sign-off that they agree to CC BY-SA 4.0 International license. Signed-off-by: Adam Jimerson <[email protected]>
1 parent 3bab6a6 commit ebb3545

File tree

2 files changed

+53
-0
lines changed

2 files changed

+53
-0
lines changed

CONTRIBUTING.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish
4+
to make via issue, email, or any other method with the owners of this repository
5+
before making a change.
6+
7+
Please note we have a code of conduct, please follow it in all your interactions
8+
with the project.
9+
10+
## Pull Request Process
11+
12+
1. Fork and clone this project locally.
13+
2. Install the dependencies for local development as listed in the "Instructions
14+
for Local Development" section of the _README.md_.
15+
2. Update the _README.md_ with details of changes to the interface, this
16+
includes new environment variables, exposed ports, useful file locations and
17+
container parameters.
18+
4. You may merge the Pull Request in once you have the sign-off of one other
19+
developer, or if you do not have permission to do that, you may request the
20+
reviewer to merge it for you.
21+
22+
## Code of Conduct
23+
24+
The Code of Conduct that is detailed in _coc.md_, as well as any amendments
25+
listed here, applies when contributing to the project.
26+
27+
### Our Responsibilities
28+
29+
Project maintainers are responsible for clarifying the standards of acceptable
30+
behavior and are expected to take appropriate and fair corrective action in
31+
response to any instances of unacceptable behavior.
32+
33+
Project maintainers have the right and responsibility to remove, edit, or
34+
reject comments, commits, code, wiki edits, issues, and other contributions
35+
that are not aligned to this Code of Conduct, or to ban temporarily or
36+
permanently any contributor for other behaviors that they deem inappropriate,
37+
threatening, offensive, or harmful.

CONTRIBUTORS.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
Contributors
2+
============
3+
4+
These people have contributed to chadev.github.io's design and implementation:
5+
This is the official list of people who can contribute
6+
(and typically have contributed) code to the
7+
chadev.github.io repo.
8+
9+
Names should be added to this file only after verifying that
10+
the individual or the individual's organization has agreed to
11+
the CC BY-SA 4.0 International found in the
12+
COPYING file
13+
14+
Please keep the list sorted.
15+
16+
- Adam Jimerson <vendion -at- gmail.com>

0 commit comments

Comments
 (0)