From f6a7d22c814095899785acdd68baba884fd65374 Mon Sep 17 00:00:00 2001 From: kha7iq Date: Thu, 22 Apr 2021 15:38:18 +0800 Subject: [PATCH] docs: add details about commit messages --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ea67a11..fa10bfc 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,6 +21,7 @@ possible. - Checking Locally - Docsify is used for documentation rendering from markdown, you can download the cli and test locally before opening a pull request. + Install ```bash npm i docsify-cli -g @@ -37,6 +38,18 @@ possible. Commit messages should be well formatted, and to make that "standardized", we are using Conventional Commits. +```shell + + []: + │ │ │ + │ │ └─> Summary in present tense. Not capitalized. No period at the end. + │ │ + │ └─> Scope (optional): eg. common, compiler, authentication, core + │ + └─> Type: chore, docs, feat, fix, refactor, style, or test. + +``` + You can follow the documentation on [their website](https://www.conventionalcommits.org).