Skip to content

Commit dce8b19

Browse files
feat: contribution guideline docs added
1 parent be2e933 commit dce8b19

File tree

2 files changed

+161
-0
lines changed

2 files changed

+161
-0
lines changed

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
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, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, 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 protected]. 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+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Contributing to Audiobook
2+
3+
We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
4+
5+
- Reporting a bug
6+
- Discussing the current state of the code
7+
- Submitting a fix
8+
- Proposing new features
9+
- Becoming a maintainer
10+
11+
## Steps to contribute
12+
13+
- Comment on the issue you want to work on. Make sure it's not assigned to someone else.
14+
15+
### Making a PR
16+
17+
> - Make sure you have been assigned the issue to which you are making a PR.
18+
> - If you make PR before being assigned, It may be labeled `invalid` and closed without merging.
19+
20+
- Fork the repo and clone it on your machine.
21+
- Add a upstream link to main branch in your cloned repo
22+
23+
```sh
24+
git remote add upstream https://github.com/codeperfectplus/SystemDashboard
25+
```
26+
27+
- Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes)
28+
29+
```sh
30+
git pull upstream dev
31+
```
32+
33+
- Create your feature branch
34+
35+
```sh
36+
git checkout -b <feature-name>
37+
```
38+
39+
- Include the changes you have made for commits
40+
41+
```sh
42+
git add <name-of-file>
43+
```
44+
45+
- Commit all the changes
46+
47+
```sh
48+
git commit -m "Meaningful commit message"
49+
```
50+
51+
- Push the changes for review
52+
53+
```sh
54+
git push origin <branch-name>
55+
```
56+
57+
- Create a PR from our repo on Github.
58+
59+
### Additional Notes
60+
61+
- Any changes should be made in the `dev` branch.
62+
- Properly describe the changes you have made with clear commit messages.
63+
- Code should be properly commented to ensure it's readability.
64+
- If you've added code that should be tested, add tests as comments.
65+
- Make sure your code properly formatted.
66+
- Issue that pull request!
67+
68+
## Issue suggestions/Bug reporting
69+
70+
When you are creating an issue, make sure it's not already present. Furthermore, provide a proper description of the changes. If you are suggesting any code improvements, provide through details about the improvements.
71+
72+
**Great Issue suggestions** tend to have:
73+
74+
- A quick summary of the changes.
75+
- In case of any bug provide steps to reproduce
76+
- Be specific!
77+
- Give sample code if you can.
78+
- What you expected would happen
79+
- What actually happens
80+
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
81+
82+
83+
## License
84+
85+
By contributing, you agree that your contributions will be licensed under its [MIT License](http://choosealicense.com/licenses/mit/).

0 commit comments

Comments
 (0)