From 96e7bd8e4938e51a537e40f081bb8547ca9a3eca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Tim=20Daubensch=C3=BCtz?= Date: Tue, 3 Nov 2015 17:19:04 +0100 Subject: [PATCH 1/2] Add branch naming conventions to readme.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 1dc4492b..2c475608 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,23 @@ For this project, we're using: * We don't use camel case for file naming but in everything Javascript related * We use `let` instead of `var`: [SA Post](http://stackoverflow.com/questions/762011/javascript-let-keyword-vs-var-keyword) +Branch names +===================== +Since we moved to Github, we cannot create branch names automatically with JIRA anymore. +To not loose context, but still being able to switch branches quickly using a ticket's number, we're recommending the following rules when naming our branches in onion. + +``` +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. + +Example +------------- +**JIRA ticket name:** `AD-1242 - Frontend caching for simple endpoints to measure perceived page load ` + +**Github branch name:** `AD-1242-caching-solution-for-stores` SCSS Code Conventions ===================== From 3fb0cc0f2677d501fb4b20b618cc7e85d8a2d5a4 Mon Sep 17 00:00:00 2001 From: Brett Sun Date: Tue, 3 Nov 2015 10:26:25 -0700 Subject: [PATCH 2/2] Small grammar fix --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 2c475608..7bca8c31 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ For this project, we're using: Branch names ===================== Since we moved to Github, we cannot create branch names automatically with JIRA anymore. -To not loose context, but still being able to switch branches quickly using a ticket's number, we're recommending the following rules when naming our branches in onion. +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. ``` AD--brief-and-sane-description-of-the-ticket