Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (21 loc) · 1.83 KB

CONTRIBUTING.md

File metadata and controls

26 lines (21 loc) · 1.83 KB

Contributing to Hera

Thank you for considering a contribution to Hera! Your time is the ultimate currency, and the community highly appreciates your willingness to dedicate some time to Hera for the benefit of everyone!

Please keep in mind the following guidelines and practices when contributing to Hera:

  1. Your commit must be signed. Hera uses an application that enforces the Developer Certificate of Origin (DCO). Currently, a Contributor License Agreement (CLA) check also appears on submitted pull requests. This can be safely ignored and is not a requirement for contributions to hera-workflows. This is an artifact as the Argo Project is slowly migrating projects from CLA to DCO.
  2. Use tox -e format to format the repository code. tox -e format maps to a usage of black, and the repository adheres to whatever black uses as its strict pep8 format. No questions asked
  3. Use tox to lint, run tests, and typecheck on the project
  4. Add unit tests for any new code you write
  5. Add an example, or extend an existing example, with any new features you may add. Use tox -e generate-examples to ensure that the documentation and examples are in sync.
  6. Increment the version of Hera. Hera adheres to semantic versioning. This increment can be performed in the pyproject.toml file. A CHANGELOG entry is expected along with version increases!

Code of Conduct

Please be mindful of and adhere to the CNCF's Code of Conduct when contributing to hera-workflows.