First and foremost, thank you for considering a contribution! Every little bit helps, and we're excited to have you as part of our community.
This document outlines how you can contribute, from reporting bugs to submitting code.
If you find a bug, please help us by opening an issue on GitHub.
When creating an issue, please include as many details as possible:
- A clear, descriptive title.
- The steps to reproduce the bug.
- The expected behavior versus the actual behavior.
- The version of the project you're using.
We'd love to hear your ideas! Please open an issue with the tag enhancement and describe your feature suggestion in detail.
If you're ready to make a code change, please follow these steps:
- Fork the repository and create your branch from
main. - Make your changes. Please follow the existing coding style and conventions.
- Write clear commit messages. We follow the Conventional Commits style (Feat, Fix, Docs, etc.)
- Create a Pull Request (PR). Your PR should describe the problem you're solving and link to any related issues.
We use a simple commit message format to keep the history clean. Your commit message should be in the format <type>: <description>.
Here are some common types:
feat: A new feature or functionality.fix: A bug fix.refactor: A code change that doesn't fix a bug or add a feature.chore: Changes to the build process or auxiliary tools, like documentation updates or folder renames.
Thank you again for your contribution! We appreciate your help in making this project better.