From f844ff336f4b713b372dfde86f339949a25febd4 Mon Sep 17 00:00:00 2001 From: Sean McArthur Date: Sun, 11 Jan 2015 19:52:45 -0800 Subject: [PATCH] chore(git): add a CONTRIBUTING.md --- CONTRIBUTING.md | 73 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 73 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..773a0958 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,73 @@ +# Contributing to Hyper + +You want to contribute? You're awesome! When submitting a Pull Request, please have your commits follow these guidelines: + +## Git Commit Guidelines + +These guidelines have been copied from the [AngularJS](https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#-git-commit-guidelines) +project. + +We have very precise rules over how our git commit messages can be formatted. This leads to **more +readable messages** that are easy to follow when looking through the **project history**. But also, +we use the git commit messages to **generate the change log**. + +### Commit Message Format +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +`` +(): + + + +