Welcome to our project! We appreciate your interest in helping us improve it.
There are multiple ways in which you can help us make this project even better.
- Contributing code improvements or new features
- Writing, updating, or fixing tests
- Improving documentation, including inline comments, user manuals, and developer guides
To make changes to the project, please follow these steps:
- Fork the project repository.
- Create a new branch for your changes, based on the project's main branch.
- Make your changes. Ensure you've followed the coding style and standards.
- Test your changes thoroughly, ensuring all existing tests pass and new tests cover your changes where appropriate.
- Commit your changes with a clear and descriptive commit message.
- Push your changes to your fork.
- Create a pull request to the project's main branch.
Once we check everything, we will merge the changes into the main branch and include it in the next release.
When submitting a pull request, please ensure that:
- Your code is properly tested
- Your code adheres to the project's coding standards and style guidelines
- Your commit message is clear and descriptive
- Your pull request includes a description of the changes you have made and why you have made them
We want to ensure a welcoming environment for everyone. With that in mind, all contributors are expected to follow our code of conduct.
By submitting a pull request you agree to release that code under the project's license.