Diego Villarreal dievilz

Commit Message Guidelines

In the last few years, the number of programmers concerned about writing structured commit messages have dramatically grown. As exposed by Tim Pope in article readable commit messages are easy to follow when looking through the project history. Moreover the AngularJS contributing guides introduced conventions that can be used by automation tools to automatically generate useful documentation, or by developers during debugging process.

This document borrows some concepts, conventions and even text mainly from these two sources, extending them in order to provide a sensible guideline for writing commit messages.

Goals
Proposal
- Commit Message Format

Allowed ``

	#!/bin/bash

	firstLine=`head -2 $1 \| tail -1`
	if [[ $firstLine == \#* ]]; then # Testing that the file starts with a comment, not yet a real commit ;)
	echo '<type>(<component>): <subject>' > .prepare-commit-msg-temp
	echo '' >> .prepare-commit-msg-temp
	echo '<body>' >> .prepare-commit-msg-temp
	echo '' >> .prepare-commit-msg-temp
	echo '# types: feat, fix, docs, style, refactor, test, chore(mantean)' >> .prepare-commit-msg-temp