Thank you for considering contributing to our project! Any contribution you make will be a valuable addition to the Company Ranking repository ✨.
In this guide, you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
If you spot a problem with the code or have a feature request, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant template.
Scan through our existing issues to find one that interests you. You can narrow down the search using labels as filters. If you find an issue to work on, you are welcome to open a PR with a fix.
- Fork the repository.
- Clone the forked repository to your local machine.
- Create a working branch and start with your changes!
Commit the changes once you are happy with them. Don't forget to write a clear and concise commit message.
When you're finished with the changes, create a pull request, also known as a PR.
- Fill in the PR template so that we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request.
- Don't forget to link PR to issue if you are solving one.
- Enable the checkbox to allow maintainer edits so the branch can be updated for a merge.
Congratulations 🎉🎉 The Company Ranking team thanks you ✨.
Once your PR is merged, your contributions will be publicly visible on the Company Ranking repository.
Thank you for being a part of our community!