ascribe/onion
1
0
Fork 0
mirror of https://github.com/ascribe/onion.git synced 2024-12-22 17:33:14 +01:00
Code Issues Releases Wiki Activity

Add rule for branch naming with Github issues

Browse Source
This commit is contained in:
Brett Sun 2016-01-21 11:04:27 +01:00
parent a23dd99b94
commit 32a8e2d789
1 changed files with 7 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -48,15 +48,18 @@ For this project, we're using:
Branch names 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-<Github-issue-id>-brief-and-sane-description-of-the-ticket
// For issues logged in JIRA:
AD-<JIRA-ticket-id>-brief-and-sane-description-of-the-ticket AD-<JIRA-ticket-id>-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. where `brief-and-sane-description-of-the-ticket` does not need to equal to the issue or ticket's title.
This allows JIRA to still track branches and pull-requests while allowing us to keep our peace of mind.
Example Example
------------- -------------