From 83c2df48dad9fa1c172eddde87b3bfc315015346 Mon Sep 17 00:00:00 2001 From: Dan Short Date: Mon, 1 Mar 2021 10:48:02 +0000 Subject: [PATCH 1/4] [JIT-2] Info on linking PRs --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 6ca7547..d140fb1 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,12 @@ 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 + +A PR can be linked by referencing the issue in the PR name or in the source branch. From 3258354d8d797e535b83cf9cc5e25aa7ab12e7aa Mon Sep 17 00:00:00 2001 From: Dan Short Date: Mon, 1 Mar 2021 10:52:35 +0000 Subject: [PATCH 2/4] Clarify branch usage --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d140fb1..513ab1a 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,8 @@ Link a commit to an issue by referencing that issue in the commit message. e.g. [JIT-1] A commit. -## Linking PRs +## 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 don't need to link individual commits. From 6957c46181f81c1bfd0a73a076b127539154dcf1 Mon Sep 17 00:00:00 2001 From: Dan Short Date: Mon, 1 Mar 2021 10:56:32 +0000 Subject: [PATCH 3/4] [JIT-2] Update comment about commits --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 513ab1a..1e71076 100644 --- a/README.md +++ b/README.md @@ -12,4 +12,4 @@ e.g. [JIT-1] A commit. 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 don't need to link individual commits. +If you're in a branch with a JIRA reference then you still link individual commits. From 914567b1926a3bdd5c9331ca4b62dca21ff12ef7 Mon Sep 17 00:00:00 2001 From: Dan Short Date: Tue, 2 Mar 2021 10:22:15 +0000 Subject: [PATCH 4/4] Add note on case sensitivity --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 1e71076..e1fe1d9 100644 --- a/README.md +++ b/README.md @@ -13,3 +13,5 @@ e.g. [JIT-1] A commit. 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