Note: This project has an MIT License so feel free to clone it and use it as you wish to.
If you find any bugs in the code or wish to add improvements to this project, please clone a fork and a create pull request. The steps for the same are outlined below.
Note: You need a GitHub account to submit a pull request.
- Navigate to the GitHub repository you wish to contribute to.
- Click on the "Fork" button that is located at the top right corner of the page. This creates a copy of the repository in your GitHub account
- After you have forked the repository, go to your profile and open the forked repository.
- Click on the green "Code" button and copy the URL provided.
- Open your preferred Git command-line tool or Git GUI.
- Use the
git clonecommand followed by the copied URL to clone your forked repository to your local machine:git clone <link_to_the_repository>
- Change your repository directory on your local machine using the
cdcommand on your terminal:cd <repository_name>
- Create a new branch for your proposed new feature or bug fix. Use a descriptive branch name:
git checkout -b feature/proposed_feature_name
- Make the necessary code changes on your local branch.
- Use the
git addcommand to add the changes to the branch:git add . - Commit your code changes with a descriptive commit message:
git commit -m "Descriptive commit message of the changes proposed"
- Push your committed changes to your forked repository on GitHub:
git push origin feature/proposed_feature_name
- Once you have successfully pushed your proposed code changes, navigate to your forked repository on GitHub.
- You should then be able to see a banner at the top indicating that you have recently pushed a new branch. Click on the "Compare & pull request" button that is next to it.
- On the Pull Request page:
- Select the base repository and the base branch (the base repository is the repository you originally forked from and the main branch).
- Select your forked repository and the branch you created (this is the repository of your proposed code changes).
- Fill in the title and description for your pull request. Be sure to provide context and adequate information about the changes you have proposed.
- Provide tests and documentation for the changes and add labels to categorize your pull request.
- Once done, click on the "Create pull request" button.
- If the maintainers of the original repository need more information or clarification, they may comment on your pull request. You should make the necessary changes based on the comments.
- Once approved, your pull request will be merged into the main branch of the original repository.
- If your changes are merged, you will officialy become a contributor to the original repository.
You can read more about contributing to projetcs, forking and submitting a pull request in the GitHub documentation: https://docs.github.com/en/get-started/quickstart/contributing-to-projects