Any contributions are more than welcome.
- Issues: Bug reports, feature requests, and questions.
- Pull Requests: Bug-fixes, feature implementations, and documentation updates.
Development requires Poetry as a dependency management system.
pip install poetry
The make install command resolves and installs the dependencies.
make install
Before making a pull request, run make format and make sure make check succeeds.
make format
make check
- Create a release branch named with the prefix "release/".
- A pull request to update the version information in the release branch is automatically generated. Then, review and merge the pull request.
- Create a pull request from "release/*" to "main", and write release notes in the description of the pull request.
- When the pull request is merged into the main branch, a PyPI release and a GitHub release page will be automatically configured.
- Please do not remove the release branch by yourself. GitHub Actions will automatically delete the release branch once the release process is done.
NOTE: dev/develop branch is no longer used for development. Please make a pull request directly into main branch.