Welcome, and thank you for considering contributing to this project! 💖
We appreciate all contributions — code, documentation, feedback, and more.
If you're new to open source or unsure where to begin:
- Check out our good first issues – perfect if you're just getting started!
- Looking to help out? See our help wanted issues
- Or contact us — we’re happy to guide you!
Once you find an issue to work on, comment with something like:
"I'd like to work on this"
This helps avoid duplication and ensures you get support.
We welcome many types of contributions:
- 💡 New features or improvements
- 🐛 Bug fixes
- 📚 Documentation updates
- 🧪 Tests or CI/CD enhancements
- 🎨 UI or design suggestions
- 📣 Blog posts or community engagement
Not all contributions require a pull request — feel free to reach out!
- Fork the repository
- Create a new branch:
git checkout -b feature/my-feature - Commit your changes
- Push to your fork and open a pull request
We review all PRs and provide feedback as needed. Please be patient and respectful during the process.
Before submitting:
- Code compiles and passes all tests
- Linting and formatting applied
- Changes documented (README, docstrings, etc.)
- Commits are signed (see below)
- The PR description explains why the change is needed
We require that all commits are signed to acknowledge your rights to contribute.
Use the -s flag when committing:
git commit -s -m "Add my awesome feature"