From ca47721071129fff3e0837665ccd585dca127128 Mon Sep 17 00:00:00 2001 From: Serguei Okladnikov Date: Tue, 12 Oct 2021 10:40:48 +0300 Subject: [PATCH 1/2] docs: add commit message convention and coding rules --- CONTRIBUTING.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b3471c9..41be0a5c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -81,6 +81,22 @@ To work on a new feature or a fix please create a new branch: $ git checkout -b feature-xyz # or fix-xyz ``` +### Coding rules + +- Unit-testing: all features or bug fixes must be tested by specs +- Documentation: all public API methods must be documented + +### Commit message convention + +Commit title must meet [angular commit message format](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format) +with ticket number at the end of summary: + +``` +(): # +``` +Summary in present tense. Not capitalized. No period at the end. +The and fields are mandatory, the () and # field is optional. + ### Run the tests before committing Please always make sure your code is passing linter and tests **before From 60bad87693b2f53e279f66b97329e8e5494ab4e2 Mon Sep 17 00:00:00 2001 From: Serguei Okladnikov Date: Tue, 12 Oct 2021 13:04:16 +0300 Subject: [PATCH 2/2] docs: lightly softify commit convention requirements --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 41be0a5c..3106d604 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -88,7 +88,7 @@ $ git checkout -b feature-xyz # or fix-xyz ### Commit message convention -Commit title must meet [angular commit message format](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format) +We use a commit convention, inspired by [angular commit message format](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-format) with ticket number at the end of summary: ```