Thank you for considering contributing to this project! Your contributions help make it better for everyone.
- Check existing issues before opening a new one to avoid duplicates.
- Provide a clear and descriptive title and a detailed description of the problem.
- Include steps to reproduce, screenshots, or code examples if relevant.
- Explain the motivation behind the enhancement.
- Provide examples of how it would improve the project.
- Keep suggestions constructive and respectful.
- Fork the repository and create a new branch for your feature or bugfix.
- Follow the project's coding style and conventions.
- Include tests if applicable.
- Ensure your code passes all existing tests.
- Submit a pull request with a clear description of your changes.
- Use conventional commits for clarity. Example:
feat: add new feature
fix: correct a bug
docs: update documentation
- Keep commits small and focused on a single change.
- Be open to feedback and make adjustments as needed.
- Review others’ pull requests constructively.
Please note that this project is governed by a Code of Conduct. By participating, you agree to follow its guidelines.
- README.md – Project overview and setup instructions
- SECURITY.md – Reporting security issues