Skip to content

Commit 8113587

Browse files
authored
Merge pull request #3335 from openziti/contributor-hints
help contributors send better pull requests
2 parents 1bd1469 + e8c9de2 commit 8113587

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,10 @@ NetFoundry welcomes all and any contributions. All open source projects managed
44
[guide for contributions](https://docs.openziti.io/policies/CONTRIBUTING.html).
55

66
If you are eager to contribute to a NetFoundry-managed open source project please read and act accordingly.
7+
8+
Some bookkeeping needs to be done for contributions.
9+
10+
- 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.
11+
- Ensure your commit messages in Git include `fix openziti/ziti#<issuer-number>` as the first line of the commit message, followed by a blank line, and then whatever detail you want to provide.
12+
- Include in the pull request the same text, `fix openziti/ziti#<issue-number>` either in the title or body.
13+
- Ensure commits are signed by a key you've associated with your GitHub handle.

0 commit comments

Comments
 (0)