So you have made your mind to contribute to this project? Here's everything you'll need to make your first contribution.
We welcome contributions of all sorts. Even the most minor changes are warmly welcomed. You may choose to work on an existing issue or propose your own.
Some examples of contributions are:
-
Documentation: From spell corrections to documenting the necessary information, all comes in this section.
-
Bugs: Any bug fixes are counted in this section. If you see a new bug, feel free to create a new issue mentioning the problem faced.
-
Feature Requests: If you would like to see some new features around the website, you can always create a new issue mentioning the requested feature.
Important: Every PR must correspond to an issue. If there isn't an issue related to the PR, open a new issue in the Issues section.
To work on an existing issue, comment on it and say you're working on that issue. Any maintainer will assign you to the issue. This is to avoid conflicts with others also working on the issue.
You can always seek help and are recommended to discuss the course of action and design decisions to tackle the issue on the issue page before making the Pull Request.
-
Fork this repository and set up the development environment as mentioned here.
-
Check out to a new branch for the patch.
git checkout -b <branch name>- Write your code.
-
Before committing changes, you should verify if the issue is fixed
-
Commit your changes. Try to follow the [best practices][best_practices] while committing changes.
git commit -s
# Then write the commit message and save changes- Push the changes to your fork.
git push -u origin <branch name>-
Create a pull request. Be sure to read and follow our pull request guidelines!
-
Wait for code review and address any issues raised.
-
Voila! You made a contribution. Keep it up.
- Add this repository as an upstream.
git remote add upstream <repo_name>- Pull the latest changes from the main branch.
git pull upstream main