Welcome and thank you for considering contributing to our project! Here, we lay out some guidelines to help make the contribution process easy and effective for everyone involved.
Before starting, please read and understand our Code of Conduct. We value our community and expect everyone participating to adhere to the principles outlined there.
- Make sure you have a GitHub account.
- Fork the repository on GitHub.
- Check the project's issue tracker to see if your proposed contribution is already under consideration or exists as a feature.
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one.
- Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
- Open a new issue on our issues list on GitHub.
- Clearly describe the enhancement and include the steps to reproduce if it's a feature. Also, explain why this feature would be useful to most users and how it should work.
- Develop and test your code changes locally.
- Commit your changes in a new branch in your forked repository.
- Submit a Pull Request with comprehensive description of changes.
- Our team will review your pull request and respond as soon as possible.
To maintain consistency and readability in our code, we ask that you follow our style guide (LINK_TO_STYLE_GUIDE) when submitting contributions.
If your changes involve any updates or additions to the project's documentation, please update the relevant sections or create them if not currently present.
Every contribution is valuable, and we will recognize all contributors to the project in our Contributor List.
Questions If you have any further questions, feel free to post it here.
Thank you again for your interest in contributing to our project!