Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

48 lines (29 loc) · 1.53 KB

Contributing Guidelines

Contributions are welcome via GitHub pull requests.

Submitting Pull Requests

Ensure you submit the pull request with PR title adhering to Conventional Commits standards. By default, we support the following types in the PR titles: Converntional Commit types

Immutability

All charts' releases must be immutable. All changes require version bump.

Versioning

Chart's version must follow the SemVer

Checks

Each PR should pass a set of checks including:

  • Linting
  • README.md must be up to date
  • Installation to an empty environment

Updating README.md

We use helm-docs tool to auto generate the documentations for helm-charts into markdown format. Use this tool to update the documentation for the chart changes that you do.

[Pro Tip] Do add comments for your values to show up as descriptions in your generated docs.

config:
  databases:
    # -- default database for storage of database metadata
    - postgres

Resulting in a resulting README section like so:

Key Type Default Description
config.databases[0] string "postgresql" default database for storage of database metadata

More info on this here.

Publishing Changes

Changes are automatically published whenever a commit is merged to main branch.