Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
59 lines (43 loc) · 1.46 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 1.46 KB

Contributing to Citadel Helm Chart

Thank you for your interest in contributing to the Citadel Helm chart.

Getting Started

Prerequisites

  • Helm 3.10+
  • kubectl configured for a cluster
  • ct (optional, for running chart tests locally)

Development Setup

  1. Clone the repository:

    git clone https://github.com/radiusmethod/citadel-helm.git
cd citadel-helm

  2. Update chart dependencies:

    helm dependency update

  3. Lint the chart:

    helm lint .

  4. Test template rendering:

    helm template test-release .

Bug Reports

Open a GitHub issue with:

  • Chart version and Kubernetes version
  • values.yaml overrides used (redact secrets)
  • Expected vs actual behavior
  • Relevant logs or error messages

Pull Requests

  1. Fork the repository and create a feature branch from main
  2. Make your changes
  3. Ensure helm lint . passes
  4. Test with helm template for common scenarios
  5. Update documentation if adding/changing values
  6. Submit a PR with a clear description of the change

PR Guidelines

  • Keep changes focused — one feature or fix per PR
  • Follow existing patterns in templates and values
  • Add comments for non-obvious template logic
  • Update CHANGELOG.md under an [Unreleased] section