Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
42 lines (29 loc) · 1.17 KB

CONTRIBUTING.md

File metadata and controls

42 lines (29 loc) · 1.17 KB

Solid Helm Charts — contribution guide

Pre-commit hooks

We use pre-commit to run some checks before committing and automatically generate documentation.

To install the pre-commit hooks, run:

pip install pre-commit
pre-commit install

Changelog

All notable changes to this project are documented in CHANGELOG.md file for each chart. The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

Types of changes

  • Added - For new features.
  • Changed - For changes in existing functionality.
  • Deprecated - For soon-to-be removed features.
  • Removed - For now removed features.
  • Fixed - For any bug fixes.
  • Security - In case of vulnerabilities.

Tasks

For some automation the project uses Task - modern task runner, a cross-platform build tool inspired by Make.

Using shared chart

To use shared chart with the current (modified locally) version you can reference it like this:

dependencies:
  - name: shared
    version: 0.1.0
    repository: file://../shared