We appreciate and value contributions from the community. Your input plays a vital role in the growth and success of this project. Please take a moment to read and understand our contribution guidelines to ensure a positive and collaborative environment for everyone involved.
All contributors are expected to adhere to our Code of Conduct. This includes treating others with respect, maintaining a welcoming and inclusive atmosphere, and resolving conflicts constructively. We strive to foster a diverse and inclusive community where everyone feels safe and valued.
To contribute to the project, we encourage you to follow these submission guidelines:
- Fork the repository and create a new branch for your contribution.
- Ensure that your code adheres to our coding style and formatting guidelines.
- Clearly document any new features, changes, or bug fixes.
- Include relevant tests that adequately cover your changes.
- Submit your contribution as a pull request to the appropriate branch.
We welcome various types of contributions, including but not limited to:
- Code improvements and bug fixes
- Documentation enhancements
- Feature requests and suggestions
- Bug reports and issue triaging
- Translations and localization efforts
If you are unsure about the type of contribution or need guidance, don't hesitate to reach out to us through the communication channels mentioned below.
For discussions, questions, and support related to contributions, you can utilize the following communication channels:
We encourage you to engage with the community, ask questions, and share your ideas. Remember to be respectful and considerate in all your interactions.
Our team of maintainers will review your contributions promptly. We will provide feedback, suggestions, and guidance to help you improve your work. Please be patient during the review process, and we appreciate your understanding.
To ensure a smooth review, please address any reviewer comments and keep the conversation focused on improving the contribution.
Contributions should be thoroughly tested to ensure their correctness and compatibility with the project. We recommend the following:
- Write unit tests to cover your code changes.
- Consider integration and end-to-end testing where applicable.
- Make sure all existing tests pass before submitting your contribution.
We value high-quality contributions that align with our project's standards.
By submitting a contribution, you agree to license your work under the terms of our chosen project license. Please review the license details carefully before submitting your contribution. Additionally, ensure that your contributions do not infringe on any third-party copyrights or intellectual property.
We recognize and appreciate the efforts of our contributors. All contributions, regardless of size, are valuable to us. As a token of our gratitude, we maintain a Contributors File where we acknowledge everyone who has contributed to the project. Your name will be included in this file upon acceptance of your contribution.
If you have any questions or need assistance regarding contributions, feel free to reach out to our team via:
- Email: Mattéo Sophys
We are here to help and support you throughout the contribution process.
Thank you for considering contributing to our project. We look forward to your valuable contributions and collaboration!