diff --git a/README.md b/README.md index 6ca7547..e1fe1d9 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,16 @@ This repo demonstrates some test functionality in Jira/GitHub. +## Linking Commits + Link a commit to an issue by referencing that issue in the commit message. e.g. [JIT-1] A commit. + +## Linking PRs and branches + +A PR can be linked by referencing the issue in the PR name or in the source branch. + +If you're in a branch with a JIRA reference then you still link individual commits. + +Note that the Jira reference is case sensitive e.g. JIT-1 != jit-1