Skip to content

Latest commit

 

History

History
17 lines (12 loc) · 1.17 KB

File metadata and controls

17 lines (12 loc) · 1.17 KB

Contributing

NetFoundry welcomes all and any contributions. All open source projects managed by NetFoundry share a common guide for contributions.

If you are eager to contribute to a NetFoundry-managed open source project please read and act accordingly.

When possible, refer to the local module README.md files for development guidance specific to the area you are working in (for example, tests/README.md for writing tests). These documents capture the conventions expected for new code in that module.

Some bookkeeping needs to be done for contributions.

  • Log an issue and tie your commits to it. Make sure the issue title clearly describes the problem, and the body of the issue explains what is happening, what is expected, and how to reproduce it.
  • Ensure your commit messages in Git include fix openziti/ziti#<issue-number> as the first line of the commit message, followed by a blank line, and then whatever detail you want to provide.
  • Include in the pull request the same text, fix openziti/ziti#<issue-number> either in the title or body.
  • Ensure commits are signed by a key you've associated with your GitHub handle.