Skip to content

Latest commit

 

History

History
58 lines (40 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

58 lines (40 loc) · 1.83 KB

Contributing Guide

This Helm Chart accepts contributions from GitHub pull requests. You can find help in this document to get your contribution accepted.

Helm Chart Guidelines

Please read the Helm Chart Guidelines before editing this chart.

Testing

Please read the testing guidelines to learn how testing is done with this chart.

Guidelines

According to the Traefik HelmChart philosophy, the guidelines for future evolutions are:

  • Fix bugs
  • improve security
  • improve HelmChart support
  • improve Kubernetes features support
  • improve Traefik default configuration

While encouraging contributions, the philosophy leads to avoid introducing:

  • Specific use cases
  • Third party CRD
  • Dashboard exposition tuning
  • Helm chart variables that shortcuts/expose static or dynamic Traefik configuration

Commit messages

Commits messages should follow conventional commits specification and should specify a scope.

All commits will appear in traefik helm chart changelog with two exceptions:

  • CRDs: CRDs are shared between Traefik and CRDs charts, thus, commits with this scope will appear in both charts changelog (e.g. feat(CRDs): update Traefik Proxy CRDs to v3.x)
  • CRDs-.*: commits with CRDs- prefixed scope will appear only on CRDs chart changelog (e.g. docs(CRDs-values: update values documentation)

Statistics

Once a year, monocle is used to gather statistics on this project.

They are gathered with this config file:

---
workspaces:
  - name: monocle
    crawlers:
      - name: github-traefik
        provider:
          github_organization: traefik
          github_repositories:
            - traefik-helm-chart
        update_since: '2022-01-01'