From 32a8e2d78936f53290ec48e38f1b6c5ee0965ac4 Mon Sep 17 00:00:00 2001 From: Brett Sun Date: Thu, 21 Jan 2016 11:04:27 +0100 Subject: [PATCH] Add rule for branch naming with Github issues --- README.md | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index e07eca0d..478562d3 100644 --- a/README.md +++ b/README.md @@ -48,15 +48,18 @@ For this project, we're using: Branch names ===================== -Since we moved to Github, we cannot create branch names automatically with JIRA anymore. -To not lose context, but still be able to switch branches quickly using a ticket's number, we're recommending the following rules when naming our branches in onion. + +To allow Github and JIRA to track branches while still allowing us to switch branches quickly using a ticket's number (and keep our peace of mind), we have the following rules for naming branches: ``` +// For issues logged in Github: +AG--brief-and-sane-description-of-the-ticket + +// For issues logged in JIRA: AD--brief-and-sane-description-of-the-ticket ``` -where `brief-and-sane-description-of-the-ticket` does not need to equal to the ticket's title. -This allows JIRA to still track branches and pull-requests while allowing us to keep our peace of mind. +where `brief-and-sane-description-of-the-ticket` does not need to equal to the issue or ticket's title. Example -------------