Skip to content

Latest commit

 

History

History
36 lines (24 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

36 lines (24 loc) · 1.19 KB
Raw

Contributing

konfig uses GitHub to manage reviews of pull requests.

  • If you have a trivial fix or improvement, go ahead and create a pull request.

  • Code must be properly formatted

Building & Testing

This repository uses bats for testing. To run the tests, install bats, then

make test

Pull Request Checklist

  • Add a DCO / Signed-off-by line in any commit message (git commit --signoff).

  • Branch from master and, if needed, rebase to the current master branch before submitting your pull request. If it doesn't merge cleanly with master you will be asked to rebase your changes.

  • Commits should be small units of work with one topic. Each commit should be correct independently.

  • Add tests relevant to the fixed bug or new feature.

Releases

This is a checklist for new releases:

  1. Create release notes in doc/releases
  2. Update usage instructions, if applicable
  3. Create a new tag via hack/make_tag.sh
  4. Push the tag to GitHub git push --tags
  5. Create new release on GitHub Releases and upload artifacts
  6. Update krew-index