Skip to content

Latest commit

 

History

History
35 lines (26 loc) · 1.47 KB

Contributing.md

File metadata and controls

35 lines (26 loc) · 1.47 KB
Raw

Contributing

We value contributions to @KineticCafe/docker-image-update-checker: bug reports, feature requests, and code contributions.

Before contributing patches, please read the Licence.md.

@KineticCafe/docker-image-update-checker reports is governed under the Kinetic Commerce Open Source Code of Conduct.

Code Guidelines

Our usual code contribution guidelines apply:

  • Code changes will not be accepted without tests. The test suite is written with vitest.
  • Match our coding style. We use Biome to assist with this.
  • Use a thoughtfully-named topic branch that contains your change. Rebase your commits into logical chunks as necessary.
  • Use quality commit messages.
  • The version number must not be changed except as part of the release process.
  • Submit a pull request with your changes.
  • New or changed behaviours require new or updated documentation.

A pull request will be accepted only if all code quality checks performed in GitHub Actions pass.

@KineticCafe/docker-image-update-checker-reports is compiled into a single file with @vercel/ncc for release. One of the status checks is that there are no changes during the packaging process. Ensure that you run pnpm all and commit any files in dist/ once you are satisfied with your changes.