Contributing Guidelines

Thank you for considering to contribute to this project. This document specifies the guidelines that you should follow when contributing.

The following steps need to be followed for you to submit a successful PR. Please adhere to the guidelines in order for your PR's to get approved.

first fork this repo

make a directory/folder on your local system and initial it,

mkdir <your directory name>
git init

then clone this repository on your local system by running below command

git clone "your forked repo url"

Work on the project

after creating your changes and in order to add your changes run the following command

git add .

Its time to commit the changes made

git commit -m "your valid commit message"

then push the changes that you have made, run the below command,

git push -u origin main

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 ❤

Provide feedback