Skip to content
This repository has been archived by the owner on Feb 9, 2023. It is now read-only.

Latest commit

 

History

History
31 lines (20 loc) · 2.06 KB

CONTRIBUTING.md

File metadata and controls

31 lines (20 loc) · 2.06 KB
Raw

Contributing to Relay

Relay welcomes contributions! Read on if you're interested in getting involved with the project.

Guidelines for contributions

All interactions between Puppet employees, contributors, and community members on Relay-related projects are subject to Puppet Community Code of Conduct.

Make sure there's not some existing code or a discussion that covers the change you want to make by searching existing Github issues.

To make it easier to contribute while still staying in the good graces of our (super wonderful!) Legal department, we require a Developer Certificate of Origin sign-off on contributions. See this explanation from the Helm project to understand the rationale behind the DCO.As a practical matter, this means adding the -s | --signoff flag to your commits.

Making Changes

  • Clone the repository into your own namespace
  • Create a topic branch from where you want to base your work.
    • To quickly create a topic branch based on main, run git checkout -b fix/my_fix origin/main.
  • Make commits of logical and atomic units.
  • Check for unnecessary whitespace with git diff --check before committing.
  • Make sure your commit messages are in the proper format. We (try to!) follow Tim Pope's guidelines for writing good commit messages: format for short lines, use the imperative mood ("Add X to Y"), describe before and after state in the commit message body. Remember to add the -s flag to commits to DCO-sign them!
  • Make sure you have added the necessary tests for your changes.
  • Submit a pull request per the usual github PR process.

Additional Resources