Skip to content

Commit 8b3ee96

Browse files
committed
Add contributing document
1 parent 686dded commit 8b3ee96

File tree

1 file changed

+103
-0
lines changed

1 file changed

+103
-0
lines changed

CONTRIBUTING.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
# Contributing
2+
3+
When contributing to this repository, please first discuss the change you wish to make via issue,
4+
discord, or any other method with the owners of this repository before making a change. We'd love
5+
your help with any of the following:
6+
7+
* Reporting a bug
8+
* Discussing the current state of the code
9+
* Submitting a fix
10+
* Proposing new features
11+
12+
Please note we have a code of conduct, please follow it in all your interactions with the project.
13+
14+
## Pull Request Process
15+
16+
1. Fork the repository and create your branch from `main`.
17+
2. Implement the changes and test it !!!
18+
3. Test it again.
19+
4. If you've changed APIs, update the documentation (README.md or documentation.md).
20+
5. Issue that pull request!
21+
22+
## Code Formatting
23+
24+
* 4 spaces - for indentation
25+
* Single quotes for string - except to avoid escaping
26+
* No unused variables - this on catches tons of bugs!
27+
* Always use === instead of == - but obj == null is allowed to check null || undefined
28+
* Look at other code in the repository if you are unsure
29+
30+
## Code of Conduct
31+
32+
### Our Pledge
33+
34+
In the interest of fostering an open and welcoming environment, we as
35+
contributors and maintainers pledge to making participation in our project and
36+
our community a harassment-free experience for everyone, regardless of age, body
37+
size, disability, ethnicity, gender identity and expression, level of experience,
38+
nationality, personal appearance, race, religion, or sexual identity and
39+
orientation.
40+
41+
### Our Standards
42+
43+
Examples of behavior that contributes to creating a positive environment
44+
include:
45+
46+
* Using welcoming and inclusive language
47+
* Being respectful of differing viewpoints and experiences
48+
* Gracefully accepting constructive criticism
49+
* Focusing on what is best for the community
50+
* Showing empathy towards other community members
51+
52+
Examples of unacceptable behavior by participants include:
53+
54+
* The use of sexualized language or imagery and unwelcome sexual attention or
55+
advances
56+
* Trolling, insulting/derogatory comments, and personal or political attacks
57+
* Public or private harassment
58+
* Publishing others' private information, such as a physical or electronic
59+
address, without explicit permission
60+
* Other conduct which could reasonably be considered inappropriate in a
61+
professional setting
62+
63+
### Our Responsibilities
64+
65+
Project maintainers are responsible for clarifying the standards of acceptable
66+
behavior and are expected to take appropriate and fair corrective action in
67+
response to any instances of unacceptable behavior.
68+
69+
Project maintainers have the right and responsibility to remove, edit, or
70+
reject comments, commits, code, wiki edits, issues, and other contributions
71+
that are not aligned to this Code of Conduct, or to ban temporarily or
72+
permanently any contributor for other behaviors that they deem inappropriate,
73+
threatening, offensive, or harmful.
74+
75+
### Scope
76+
77+
This Code of Conduct applies both within project spaces and in public spaces
78+
when an individual is representing the project or its community. Examples of
79+
representing a project or community include using an official project e-mail
80+
address, posting via an official social media account, or acting as an appointed
81+
representative at an online or offline event. Representation of a project may be
82+
further defined and clarified by project maintainers.
83+
84+
### Enforcement
85+
86+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
87+
reported by contacting the project team in the [Discord Server](https://discord.gg/YtQMYYK2kM).
88+
All complaints will be reviewed and investigated and will result in a response that
89+
is deemed necessary and appropriate to the circumstances. The project team is
90+
obligated to maintain confidentiality with regard to the reporter of an incident.
91+
Further details of specific enforcement policies may be posted separately.
92+
93+
Project maintainers who do not follow or enforce the Code of Conduct in good
94+
faith may face temporary or permanent repercussions as determined by other
95+
members of the project's leadership.
96+
97+
### Attribution
98+
99+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
100+
available at [http://contributor-covenant.org/version/1/4][version]
101+
102+
[homepage]: http://contributor-covenant.org
103+
[version]: http://contributor-covenant.org/version/1/4/

0 commit comments

Comments
 (0)