-
Before writing any code take a look at the existing issues. If none of them is about the changes you want to contribute, open up a new issue. Fixing a typo requires no issue though, just submit a Pull Request.
-
If you're looking for an open issue to fix, check out labels
help wanted
andgood first issue
on GitHub. -
If you plan to work on an issue open not by you, write about your intention in the comments before you start working.
-
Follow the GitHub fork & pull request flow.
-
Install babashka
-
Make changes to the code.
-
Make sure tests pass:
$ bb test
-
Open a pull request, refer to the issue you solve.
-
Make sure GitHub Checks (Actions) pass.
- Follow the SemVer conventions for the release number.
- Update the CHANGELOG.
- Update the README if needed.
- Merge the changes to the
main
branch. - Push a version-specific tag, e.g.
v2.1.9
:
$ git tag v2.1.9
$ git push origin v2.1.9
- Push a new or over a major version tag, e.g.
v2
.
# Delete the old local tag
$ git tag -d v2
# Add a new local tag
$ git tag v2
# Delete the old remote tag
$ git push -d origin v2
# Push the new remote tag
$ git push origin v2
- Draft a new release on the GitHub. Make sure the version-specific tag and the changelog are used for the release notes. Start a discussion thread for the release. Publish links to the testing if needed (may be a good idea for release candidates).