Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (29 loc) · 1.51 KB

CONTRIBUTING.md

File metadata and controls

39 lines (29 loc) · 1.51 KB

Contributing

Development Environment

The development environment is managed by nix. If installing nix is not an option, you can ensure all the tools listed in flake.nix are installed and available in $PATH.

To install nix, either follow the official guide or zero-to-nix's quick start.

Next, you'll want to enable the experimental features flakes and nix-command to avoid typing --extra-experimental-features nix-command --extra-experimental-features flakes all the time.

# Or open the file in an editor and paste in this line.
# If you're using nix to manage your nix install, you'll have to find your own path :)
echo 'experimental-features = nix-command flakes' >> /etc/nix/nix.conf

Now you're ready to go!

nix develop # Enter a development shell.
task shell # Or enter through task
nix develop -c fish  # Enter a development shell using fish/zsh
nix develop -c zsh  # Enter a development shell using fish/zsh

Making Changes

User facing changes should be documented in [the CHANGELOG][./CHANGELOG.md] under the chart appropriate subheading. Changes are grouped into "Added, Changed, Fixed, and Removed". Breaking changes1 and deprecations should be prefixed with the "BREAKING" and "DEPRECATED", respectively.

Footnotes

  1. A change is considered breaking if the values.yaml, sans deprecated fields, from the previous release cannot be used in a helm upgrade command without modifications. ↩