From df53263e24cb28e8ff233d71371ad3ae46c4b25a Mon Sep 17 00:00:00 2001 From: iteles Date: Tue, 11 Aug 2015 23:47:18 +0100 Subject: [PATCH] Adds git commit section. Fixes https://github.com/dwyl/start-here/issues/49, link to https://github.com/dwyl/style-guide/issues/2 --- README.md | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/README.md b/README.md index cfe3ab1..3b85149 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,10 @@ For now, the **visual** and **coding styles** [will live in the _same repo_](htt + [General guidelines](#general) + [Indentation](#indentation) + [Intelligently commenting your code](#intelligently-commenting-your-code) ++ [Git](#git) + + [Issues](#issues) + + [Commits](#commits) + + [Pull requests](#pull-requests) + [Markdown](#markdown) + [ ] [CSS](#css) + [ ] [JavaScript](#javascript) @@ -59,6 +63,33 @@ else { ```
+##Git + +###Issues + +###Commits ++ Use the **third person present tense** in your commit messages, as if you were finishing off the sentence _"This commit message..."_ + + For example `adds riot.js to index` or `fixes #12 disappearing content bug` ++ Include and **issue number in _every commit message_** + + The commit message will then appear within that issue and ensure traceability of every contribution + +commit-message-referenced-from-issue ++ Keep your commits **'common sensibly small'** + + A good rule of thumb is that _if you have to use the word 'and' in your commit message, you're probably doing too much in a single commit_ unless the things you're committing are intrinsically tied together. ++ If you're **pairing**, consider giving your pair some credit in your commit messages by including their initials: + +paired-commit-message ++ Did you know you can [use emojis in your commit messages](https://github.com/dwyl/start-here/issues/49)? It's totally a thing. +emojis-in-commit-messages + + + +###Pull Requests + +- [ ] Adding issues numbers to every commit to ensure there's always traceability +- [ ] Writing a good issue +- [ ] Writing a descriptive pull request that speeds up review time and reduces the amount of back and forth between the requestee and the + ##Markdown [This is a good reference for markdown syntax](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). For readability, we use `_` _underscores_ `_` for _italics_ and `**` **double asterisks** `**` for **bold**.