Skip to content

Create CONTRIBUTING.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 2, 2022
Merged

Create CONTRIBUTING.md #1

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## Contributing Guidelines

Thank you for considering to contribute to this project.

This document specifies the guidelines that you should follow when contributing to this project.

Please adhere to the guidelines in order for your PR's to get approved.

### General Rules :
These are general rules that you should follow when contributing to an Open Source project :

- Be Nice, Be Respectful (BNBR)
- Check if the issue you opened exists or not. If it exists do not reopen it.
- While opening a new issue, make sure you describe the issue clearly.
- Write proper commit messages and document your PR well.
- Always add comments in your code and explain it at points, if possible add Doctest.
- Always create a Pull Request from a new branch such as **feature**; do not create a PR from **main**.
- Write clean code and follow proper coding conventions.

Thank you ❤