Thank you for considering contributing to this project! 🎉
Whether you’re fixing a bug, adding a feature, or improving documentation—your help is appreciated.
If you find a bug, have a question, or want to suggest an improvement,
please open an issue.
Describe the problem clearly so it can be understood and discussed.
If your idea is approved in an issue:
- Fork the repository
- Create a new branch for your change
- Make your edits
- Push your branch
- Open a Pull Request (PR)
Please keep PRs focused on one change at a time so they’re easier to review.
To help maintain consistency:
- Keep code clean and readable ✨
- Use clear naming conventions
- Add comments when needed
- Avoid large, unrelated changes in a single PR
Good commit messages make the history easier to understand. Aim for:
- Short, clear summaries
- Present-tense wording (e.g., "Fix bug in X")
- Additional context in the body if needed
Make sure you:
- Tested your changes 🧪
- Updated documentation if needed 📚
- Linked the related issue (e.g.,
Closes #12) - Wrote clear notes explaining the change
When submitting a PR:
- Keep it focused and easy to review
- Be open to feedback 💬
- Stay respectful in discussions
- Maintainers may ask for changes before merging
Your contributions help make this project better for everyone.
We appreciate your time, effort, and creativity!