Skip to content

Commit 622fd1a

Browse files
Create CONTRIBUTING.md
1 parent 00cc4eb commit 622fd1a

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

CONTRIBUTING.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Contributing Guidelines
2+
3+
Thank you for considering to contribute to this project.
4+
5+
This document specifies the guidelines that you should follow when contributing to this project.
6+
7+
Please adhere to the guidelines in order for your PR's to get approved.
8+
9+
### General Rules :
10+
These are general rules that you should follow when contributing to an Open Source project :
11+
12+
- Be Nice, Be Respectful (BNBR)
13+
- Check if the issue you opened exists or not. If it exists do not reopen it.
14+
- While opening a new issue, make sure you describe the issue clearly.
15+
- Write proper commit messages and document your PR well.
16+
- Always add comments in your code and explain it at points, if possible add Doctest.
17+
- Always create a Pull Request from a new branch such as **feature**; do not create a PR from **main**.
18+
- Write clean code and follow proper coding conventions.
19+
20+
Thank you ❤

0 commit comments

Comments
 (0)