From 622fd1a5dc961de39fa7d9cae1c76c5e12c7c05b Mon Sep 17 00:00:00 2001 From: Kishan Kumar Rai Date: Sun, 2 Oct 2022 23:20:11 +0530 Subject: [PATCH] Create CONTRIBUTING.md --- CONTRIBUTING.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..78fa5b74 --- /dev/null +++ b/CONTRIBUTING.md @@ -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 ❤