If you want to make a contribution to the repository, follow these steps :
-- Please follow the Code Of Conduct of this project and keep this in mind while contributing --
-
Fork this repository to your own Github account by clicking the Fork button on the top right corner.
-
Clone the repository
Now, clone this repository to your local system. To clone the repo you will have to copy the link from your remote repo and enter the command below in your Git Bash terminal.
> git clone <repo_link_from_your_account>
- Make you changes/contributions
Now, make your changes/contributions in your local repository.
- Create a new branch
Before commiting your changes create a new branch for the feature/bug you are working on and checkout to that branch using the below command.
> git checkout -b <feature/bug_branch_name>
- Stage your changes
Now, stage your changes using the below command.
> git add .
- Commit your changes
Finally, commit your changes and add a commit message using the following command.
> git commit -m 'describe your changes here'
- Push the changes
After commiting the changes you have to push these changes into your remote repo using the below command
> git push origin <feature_branch_name>
- Raise a Pull Request
After pushing the changes come back to this repository and reload this repo, you will then find an option that says
"Compare and Pull request"
Click on that and you will have to give the title and description of the changes you made and finally click on the Create pull request button
/-- If you don't find the above option you can come here and click on New pull request then select the compare across forks button and select your repo and branch to the base branch and click on Create pull request. --/
That's it! You have successfully made your contribution 🎉
-- Note : If you want to request for a new feature or report any bug in the project, feel free to report an issue --