Skip to content

Latest commit

 

History

History
87 lines (62 loc) · 2.96 KB

CONTRIBUTING.md

File metadata and controls

87 lines (62 loc) · 2.96 KB
Raw

Contributing Guidelines

Contributions are welcome via GitHub pull requests.

Requirements

  1. Must pass DCO check
  2. Must pass Versioning check
  3. Must pass Documentation check
  4. Must pass Squashing check
  5. Must pass Lint check

Sign Your Work

To certify you agree to the Developer Certificate of Origin you must sign-off each commit message using git commit --signoff, or manually write the following:

This is my commit message

Signed-off-by: John Smith <[email protected]>

The text of the agreement is:

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.

Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

Versioning

The chart version should follow SemVer:

  • If you REMOVE/CHANGE a value → bump a MAJOR version
  • If you ADD a value → bump a MINOR version
  • If you fix a bug → bump a PATCH version

Documentation

Most non-patch changes will require documentation updates.

If you ADD a value:

  • ensure the value has a descriptive docstring in values.yaml
  • ensure the value is listed under #helm-chart-values in README.md (if it is a top-level value, e.g. airflow.config or dags.path)

If you bump a MAJOR/MINOR version:

  • add a heading for the new version to UPGRADE.md
  • add a link to the heading under #upgrade-steps in README.md

Squash Commits

Unless having multiple commits makes the PR more clear, please squash your commits and force push your branch.

Linting

Please ensure ct lint from chart-testing succeeds.