From dbbb4c0bbc48ed0eeae11212100ae0e61ad22c6c Mon Sep 17 00:00:00 2001 From: Lukas Geiger Date: Wed, 6 Sep 2017 02:12:41 +0200 Subject: [PATCH] docs: Add contributing guide Thiis mainly explains how to properly format commit messages for semantic-release --- CONTRIBUTING.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 53 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..3a83ae9 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# Contributing to `node-abi` + +:+1::tada: First off, thanks for taking the time to contribute to `node-abi`! :tada::+1: + +## Commit Message Guidelines + +This module uses [`semantic-release`](https://github.com/semantic-release/semantic-release) to automatically release new versions via Travis. +Therefor we have very precise rules over how our git commit messages can be formatted. + +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** ([full explanation](https://github.com/stevemao/conventional-changelog-angular/blob/master/convention.md)): + +``` +(): + + + +