Skip to content

Commit f6243bd

Browse files
committed
added the contributing guidelines and added package-lock.json (Thanks to @poteirard)
1 parent d99d88f commit f6243bd

File tree

3 files changed

+6855
-1
lines changed

3 files changed

+6855
-1
lines changed

.gitignore

-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1 @@
11
node_modules
2-
package-lock.json

CONTRIBUTING.md

+152
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,152 @@
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 changes in order to avoid wasting your time.
5+
6+
## scope
7+
8+
Please keep the scope of a PR down to a single change.
9+
You can make multiple prs to change multiple things though.
10+
11+
## builds
12+
13+
Don't modify anything in the build/ directory please.
14+
This will be done on release.
15+
16+
## Pull Request Process
17+
18+
1. Code away :D
19+
2. Update the README.md with details of changes to the interface, this includes new environment
20+
variables, exposed ports, useful file locations and container parameters.
21+
_Please don't change the format of the variable table in the README_
22+
3. Add the section "[next]" to the CHANGELOG.md and describe what you changed and why.
23+
4. Create the PR. yay.
24+
25+
## Contributor Covenant Code of Conduct
26+
27+
### Our Pledge
28+
29+
We as members, contributors, and leaders pledge to make participation in our
30+
community a harassment-free experience for everyone, regardless of age, body
31+
size, visible or invisible disability, ethnicity, sex characteristics, gender
32+
identity and expression, level of experience, education, socio-economic status,
33+
nationality, personal appearance, race, religion, or sexual identity
34+
and orientation.
35+
36+
We pledge to act and interact in ways that contribute to an open, welcoming,
37+
diverse, inclusive, and healthy community.
38+
39+
### Our Standards
40+
41+
Examples of behavior that contributes to a positive environment for our
42+
community include:
43+
44+
- Demonstrating empathy and kindness toward other people
45+
- Being respectful of differing opinions, viewpoints, and experiences
46+
- Giving and gracefully accepting constructive feedback
47+
- Accepting responsibility and apologizing to those affected by our mistakes,
48+
and learning from the experience
49+
- Focusing on what is best not just for us as individuals, but for the
50+
overall community
51+
52+
Examples of unacceptable behavior include:
53+
54+
- The use of sexualized language or imagery, and sexual attention or
55+
advances of any kind
56+
- Trolling, insulting or derogatory comments, and personal or political attacks
57+
- Public or private harassment
58+
- Publishing others' private information, such as a physical or email
59+
address, without their explicit permission
60+
- Other conduct which could reasonably be considered inappropriate in a
61+
professional setting
62+
63+
### Enforcement Responsibilities
64+
65+
Community leaders are responsible for clarifying and enforcing our standards of
66+
acceptable behavior and will take appropriate and fair corrective action in
67+
response to any behavior that they deem inappropriate, threatening, offensive,
68+
or harmful.
69+
70+
Community leaders have the right and responsibility to remove, edit, or reject
71+
comments, commits, code, wiki edits, issues, and other contributions that are
72+
not aligned to this Code of Conduct, and will communicate reasons for moderation
73+
decisions when appropriate.
74+
75+
### Scope
76+
77+
This Code of Conduct applies within all community spaces, and also applies when
78+
an individual is officially representing the community in public spaces.
79+
Examples of representing our community include using an official e-mail address,
80+
posting via an official social media account, or acting as an appointed
81+
representative at an online or offline event.
82+
83+
### Enforcement
84+
85+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
86+
reported to the community leaders responsible for enforcement at
87+
88+
All complaints will be reviewed and investigated fairly.
89+
90+
All community leaders are obligated to respect the privacy and security of the
91+
reporter of any incident.
92+
93+
### Enforcement Guidelines
94+
95+
Community leaders will follow these Community Impact Guidelines in determining
96+
the consequences for any action they deem in violation of this Code of Conduct:
97+
98+
#### 1. Correction
99+
100+
**Community Impact**: Use of inappropriate language or other behavior deemed
101+
unprofessional or unwelcome in the community.
102+
103+
**Consequence**: A private, written warning from community leaders, providing
104+
clarity around the nature of the violation and an explanation of why the
105+
behavior was inappropriate. A public apology may be requested.
106+
107+
#### 2. Warning
108+
109+
**Community Impact**: A violation through a single incident or series
110+
of actions.
111+
112+
**Consequence**: A warning with consequences for continued behavior. No
113+
interaction with the people involved, including unsolicited interaction with
114+
those enforcing the Code of Conduct, for a specified period of time. This
115+
includes avoiding interactions in community spaces as well as external channels
116+
like social media. Violating these terms may lead to a temporary or
117+
permanent ban.
118+
119+
#### 3. Temporary Ban
120+
121+
**Community Impact**: A serious violation of community standards, including
122+
sustained inappropriate behavior.
123+
124+
**Consequence**: A temporary ban from any sort of interaction or public
125+
communication with the community for a specified period of time. No public or
126+
private interaction with the people involved, including unsolicited interaction
127+
with those enforcing the Code of Conduct, is allowed during this period.
128+
Violating these terms may lead to a permanent ban.
129+
130+
#### 4. Permanent Ban
131+
132+
**Community Impact**: Demonstrating a pattern of violation of community
133+
standards, including sustained inappropriate behavior, harassment of an
134+
individual, or aggression toward or disparagement of classes of individuals.
135+
136+
**Consequence**: A permanent ban from any sort of public interaction within
137+
the community.
138+
139+
### Attribution
140+
141+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
142+
version 2.0, available at
143+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
144+
145+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
146+
enforcement ladder](https://github.com/mozilla/diversity).
147+
148+
[homepage]: https://www.contributor-covenant.org
149+
150+
For answers to common questions about this code of conduct, see the FAQ at
151+
https://www.contributor-covenant.org/faq. Translations are available at
152+
https://www.contributor-covenant.org/translations.

0 commit comments

Comments
 (0)