How to Contribute

We would love to accept your patches and contributions to this project.

Before you begin

Sign our Contributor License Agreement

Contributions to this project must be accompanied by a Contributor License Agreement (CLA). You (or your employer) retain the copyright to your contribution; this simply gives us permission to use and redistribute your contributions as part of the project.

If you or your current employer have already signed the Google CLA (even if it was for a different project), you probably don't need to do it again.

Visit https://cla.developers.google.com/ to see your current agreements or to sign a new one.

Review our Community Guidelines

This project follows Google's Open Source Community Guidelines.

Contribution process

Code Reviews

All submissions, including submissions by project members, require review. We use GitHub pull requests for this purpose.

Coding standards

HLint should report no issues, and formatting should be according to Ormolu.

Changes to code should include corresponding tests, which should ideally be property-based. This project uses Hspec and QuickCheck for testing.

Updating versions

When updating the version, these files should be updated accordingly:

• CHANGELOG.md with user-visible changes.
• package.yaml with the new version.
• action.yaml with the new version for the Docker image.

Once that is done, a release should be done with the new version number. After the release actions are complete, the tag for the major version should be updated. Do not delete any hlint-scan packages, as it may render previous versions inaccessible.