Thank you for contributing to GitHub Analyzer! Below you can find some core guidelines for contributing to the project.
Be kind and respectful to the members of the community. Take time to educate others who are seeking help. Harassment of any kind will not be tolerated.
If you have questions or ideas that are not a good fit for an issue (i.e., not a feature request or bug) feel free to use the repository's discussions to get feedback from the community and maintainers.
-
When filing a bug or request, please check existing issues to see if there exist some issue capturing the same topic already.
-
When filing bugs, please provide as detailed steps of reproduction as possible.
-
You can submit changes via pull requests (PRs). PRs will only be getting reviewed once all lint and unit test steps are passing. We will do our best to reply to requests for reviews in a timely manner, however we cannot provide an SLA for reviews.
-
The current license will remain, and we might introduce a requirement for contributors to sign a CLA once the project matures.
- Ensure you have pre-commit installed as it will be used for formatting and linting during PRs
- Fork the project in your account
- Create your feature branch (
git checkout -b your_handle/your-feature) - Make changes and add them to staging (
git add .) - Commit your changes (
git commit -m 'a short description of your feature') - Push to your branch (
git push origin your_handle/your-feature) - Create new pull request