Contributing

We seek any feedback and are open to contribution.

Feel free to:

It would be very helpful if you:

tell us what is missing in the documentation and examples,
share your experience report,
propose features that you find critical or extremely useful,
share goyek with others by writing a blog post, giving a speech at a meetup or conference, or even telling your colleagues that you work with.

Make sure to be familiar with our Code of Conduct.

Developing

Run ./goyek.sh (Bash) or .\goyek.ps1 (PowerShell) to execute the build pipeline.

The repository contains basic confiugration for Visual Studio Code.

Create a pull request named Release <version> to update the CHANGELOG.md:

Change the Unreleased header to represent the new release.
Consider adding a description for the new release. Especially if it adds new features or introduces breaking changes.

Add and push a signed tag:

TAG='v<version>'
COMMIT='<commit-sha>'
git tag -s -m $TAG $TAG $COMMIT
git push upstream $TAG

Create a GitHib Release named <version> with v<version> tag.

The release description should include all the release notes from the CHANGELOG.md for this release.