Contributing
Contributions are welcome! Please file issues and submit pull requests on GitHub.
Branching Model
main ← 📦 production releases dev ← 🛠 active development (default Pull Request target)
main
holds only stable, version-tagged releases.dev
is the rolling integration branch where all feature / fix PRs land first.
Maintainers periodically open an internal PR fromdev
→main
when a new release is ready.
How to Open a Pull Request
- Fork the repository to your GitHub account.
- Clone your fork and set the upstream remote:
- Sync & branch off
dev
: - Do your work → commit:
- Push to your fork:
- Open a pull request into
dev
(set the PR’s base branch todev
). - Address any review comments & keep your feature branch updated with the latest
dev
if needed.
Note: Once your PR is merged into
dev
, the maintainers will handle promotingdev
tomain
when preparing a new release—please don’t open PRs directly againstmain
.
This project is licensed under the MIT see LICENSE.