Skip to content

Commit 66d6b67

Browse files
committed
Inserting contributing in documentation
1 parent d962990 commit 66d6b67

File tree

4 files changed

+104
-2
lines changed

4 files changed

+104
-2
lines changed

docs/docs/codeConduct.md

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
---
2+
id: code-of-conduct
3+
title: Code of Conduct
4+
sidebar_label: Code of Conduct
5+
---
6+
7+
## Our Pledge
8+
9+
In the interest of fostering an open and welcoming environment, we as
10+
contributors and maintainers pledge to making participation in our project and
11+
our community a harassment-free experience for everyone, regardless of age, body
12+
size, disability, ethnicity, sex characteristics, gender identity and expression,
13+
level of experience, education, socio-economic status, nationality, personal
14+
appearance, race, religion, or sexual identity and orientation.
15+
16+
## Our Standards
17+
18+
Examples of behavior that contributes to creating a positive environment
19+
include:
20+
21+
- Using welcoming and inclusive language
22+
- Being respectful of differing viewpoints and experiences
23+
- Gracefully accepting constructive criticism
24+
- Focusing on what is best for the community
25+
- Showing empathy towards other community members
26+
27+
Examples of unacceptable behavior by participants include:
28+
29+
- The use of sexualized language or imagery and unwelcome sexual attention or
30+
advances
31+
- Trolling, insulting/derogatory comments, and personal or political attacks
32+
- Public or private harassment
33+
- Publishing others' private information, such as a physical or electronic
34+
address, without explicit permission
35+
- Other conduct which could reasonably be considered inappropriate in a
36+
professional setting
37+
38+
## Our Responsibilities
39+
40+
Project maintainers are responsible for clarifying the standards of acceptable
41+
behavior and are expected to take appropriate and fair corrective action in
42+
response to any instances of unacceptable behavior.
43+
44+
Project maintainers have the right and responsibility to remove, edit, or
45+
reject comments, commits, code, wiki edits, issues, and other contributions
46+
that are not aligned to this Code of Conduct, or to ban temporarily or
47+
permanently any contributor for other behaviors that they deem inappropriate,
48+
threatening, offensive, or harmful.
49+
50+
## Scope
51+
52+
This Code of Conduct applies both within project spaces and in public spaces
53+
when an individual is representing the project or its community. Examples of
54+
representing a project or community include using an official project e-mail
55+
address, posting via an official social media account, or acting as an appointed
56+
representative at an online or offline event. Representation of a project may be
57+
further defined and clarified by project maintainers.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported by contacting the project team at [email protected]. All
63+
complaints will be reviewed and investigated and will result in a response that
64+
is deemed necessary and appropriate to the circumstances. The project team is
65+
obligated to maintain confidentiality with regard to the reporter of an incident.
66+
Further details of specific enforcement policies may be posted separately.
67+
68+
Project maintainers who do not follow or enforce the Code of Conduct in good
69+
faith may face temporary or permanent repercussions as determined by other
70+
members of the project's leadership.
71+
72+
## Attribution
73+
74+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
75+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
76+
77+
[homepage]: https://www.contributor-covenant.org
78+
79+
For answers to common questions about this code of conduct, see
80+
https://www.contributor-covenant.org/faq

docs/docs/howContribute.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,18 @@ title: How to Contribute
44
sidebar_label: How to Contribute
55
---
66

7-
To do
7+
When contributing to this repository, please first discuss the change you wish to make via issue,
8+
email, or any other method with the owners of this repository before making a change.
9+
10+
Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct). By participating in this project you agree to abide by its terms.
11+
12+
## Pull Request Process
13+
14+
1. Ensure any install or build dependencies are removed before the end of the layer when doing a
15+
build.
16+
2. Update the README.md with details of changes to the interface, this includes new environment
17+
variables, exposed ports, useful file locations and container parameters.
18+
3. Increase the version numbers in any examples files and the README.md to the new version that this
19+
Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
20+
4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you
21+
do not have permission to do that, you may request the second reviewer to merge it for you.

docs/website/sidebars.json

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
{
22
"docs": {
3-
"Getting Started": ["getting-started", "structure", "scripts", "projects"]
3+
"Getting Started": [
4+
"getting-started",
5+
"structure",
6+
"scripts",
7+
"projects",
8+
"how-contribute",
9+
"code-of-conduct"
10+
]
411
}
512
}

docs/website/siteConfig.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ const siteConfig = {
4040
// For no header links in the top nav bar -> headerLinks: [],
4141
headerLinks: [
4242
{ doc: 'getting-started', label: 'Docs' },
43+
{ doc: 'how-contribute', label: 'Contributing' },
4344
{ page: 'help', label: 'Help' }
4445
],
4546

0 commit comments

Comments
 (0)