We'd love for you to contribute to our project! Here's a quick guide to get you started.
- Search for existing issues: Check if the bug has already been reported.
- Create a new issue: If the bug is new, create a clear and concise issue. Include the following:
- A clear and descriptive title
- Steps to reproduce the bug
- Expected behavior
- Actual behavior
- Screenshots or screen recordings (if applicable)
- Discuss your idea: Create an issue to discuss your feature idea with the community.
- Provide context: Explain why this feature is important and how it will benefit users.
- Fork the repository: Create your own copy of the repository.
- Create a new branch: Base your work on a new branch.
- Make your changes: Commit your changes with clear and concise commit messages.
- Push to your branch: Push your changes to your fork.
- Create a pull request: Submit a pull request to the main repository.
Please read our Code of Conduct for guidelines on how to interact with others in this project.
- Coding style: Follow our coding style guidelines (link to your style guide)
- Commit message conventions: Use clear and concise commit messages (link to a commit message convention, e.g., Conventional Commits)
- Testing: Please add tests for any new features or bug fixes.
- Documentation: Update the documentation to reflect any changes.
- Licensing: By contributing, you agree to license your code under the same terms as the rest of the project.
Thanks for your contribution!