Skip to content

Commit b948b20

Browse files
Merge pull request #9 from code-reaper08/code-reaper08-contrib-docs
docs: add CONTRIBUTING.md and CODE_OF_CONDUCT.md Fixes #10
2 parents 48b5164 + 2a4693b commit b948b20

File tree

2 files changed

+123
-0
lines changed

2 files changed

+123
-0
lines changed

CODE_OF_CONDUCT.md

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

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Contributing to OnlyHTML
2+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
3+
4+
- Reporting a bug 🐛
5+
- Discussing the current state of the code 📢
6+
- Submitting a fix 🩹
7+
- Proposing new features 🆕
8+
9+
## We Develop with Github
10+
We use github to host code, to track issues and feature requests, as well as accept pull requests.
11+
12+
## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
13+
Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
14+
15+
1. Fork the repo and create your branch from `main` or `website`.
16+
2. If you've added code that should be tested, add tests.
17+
3. Ensure the test suite passes.
18+
4. Make sure your code lints.
19+
5. Issue that pull request!
20+
21+
## Any contributions you make will be under the MIT Software License
22+
In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
23+
24+
## Report bugs using Github's [issues](https://github.com/code-reaper08/OnlyHTML/issues)
25+
We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue); it's that easy!
26+
27+
## Write bug reports with detail, background, and sample code
28+
**Great Bug Reports** tend to have:
29+
30+
- A quick summary and/or background
31+
- Steps to reproduce
32+
- Be specific!
33+
- Give sample code if you can.
34+
- What you expected would happen
35+
- What actually happens
36+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
37+
38+
People *love* thorough bug reports. I'm not even kidding.
39+
40+
## Use a Consistent Coding Style
41+
**run lint checks**
42+
43+
**keep the code style consistent and readable**
44+
45+
## License
46+
By contributing, you agree that your contributions will be licensed under its MIT License.
47+
48+
## References
49+
This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/main/CONTRIBUTING.md)

0 commit comments

Comments
 (0)