From e42567fdd596c60738513e669450c75cbc129dac Mon Sep 17 00:00:00 2001 From: Stanimira Vlaeva Date: Mon, 19 Feb 2018 14:02:44 +0200 Subject: [PATCH] docs(CONTRIBUTING): add commit message guidelines (#5430) --- CONTRIBUTING.md | 129 +++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 128 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 39ecb6236..eb02a9a87 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,6 +7,7 @@ Here are some guides on how to do that: - [Reporting Bugs](#bugs) - [Requesting New Features](#features) - [Submitting a PR](#pr) + - [Commit Message Guidelines](#commit-messages) ## Code of Conduct Help us keep a healthy and open community. We expect all participants in this project to adhere to the [NativeScript Code Of Conduct](https://github.com/NativeScript/codeofconduct). @@ -73,6 +74,132 @@ git push origin --force It's our turn from there on! We will review the PR and discuss changes you might have to make before merging it! Thanks! -### Where to Start +## Commit Message Guidelines + +Please follow the git commit message format described below when committing your changes or submitting a PR. That allows us to use the commit messages to generate a change log for every new release. + +### 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**: + +``` +(): + + + +