From f48b6a9ae6b9fbe4b507ae96404d6b6954734e0c Mon Sep 17 00:00:00 2001
From: Shidong Wang <wsdjeg@outlook.com>
Date: Tue, 28 Sep 2021 23:37:52 +0800
Subject: [PATCH] doc(core): add `:h SpaceVim-dev`

---
 autoload/SpaceVim.vim | 57 ++++++++++++++++++++++++++++++++++++++-
 doc/SpaceVim.txt      | 62 +++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 116 insertions(+), 3 deletions(-)

diff --git a/autoload/SpaceVim.vim b/autoload/SpaceVim.vim
index 2f5c658c5..a5925c002 100644
--- a/autoload/SpaceVim.vim
+++ b/autoload/SpaceVim.vim
@@ -11,7 +11,7 @@ scriptencoding utf-8
 " @section Introduction, intro
 " @stylized spacevim
 " @library
-" @order intro options config layers usage api faq changelog
+" @order intro options config layers usage api dev faq changelog
 " SpaceVim is a bundle of custom settings and plugins with a modular
 " configuration for Vim. It was inspired by Spacemacs.
 "
@@ -1621,6 +1621,61 @@ endfunction
 "   SPC b D	      kill a visible buffer using vim-choosewin
 " <
 
+""
+" @section Development, dev
+"
+" SpaceVim is a joint effort of all contributors.
+" We encourage you to participate in SpaceVim's development.
+" We have some guidelines that we need all contributors to follow.
+
+
+""
+" @section commit-style-guide, dev-commit-style-guide
+" @parentsection dev
+" A git commit message consists a three distinct parts separated by black line.
+" >
+"   Type (scope): Subject
+" 
+"   body
+"
+"   footer
+" <
+" types:
+"
+" - `feat`: a new feature
+" - `fix`: a bug fix
+" - `change`: no backward compatible changes
+" - `docs`: changes to documentation
+" - `style`: formatting, missing semi colons, etc; no code change
+" - `refactor`: refactoring production code
+" - `test`: adding tests, refactoring test; no production code change
+" - `chore`: updating build tasks, package manager configs, etc; no production code change
+"
+" scopes:
+"
+" - `api`: files in `autoload/SpaceVim/api/` and `docs/api/` directory
+" - `layer`: files in `autoload/SpaceVim/layers/` and `docs/layers/` directory
+" - `plugin`: files in `autoload/SpaceVim/plugins/` directory
+" - `bundle`: files in `bundle/` directory
+" - `core`: other files in this repository
+"
+" subject:
+"
+" Subjects should be no greater than 50 characters,
+" should begin with a capital letter and do not end with a period.
+"
+" Use an imperative tone to describe what a commit does,
+" rather than what it did. For example, use change; not changed or changes.
+"
+" body:
+"
+" Not all commits are complex enough to warrant a body,
+" therefore it is optional and only used when a commit requires a bit of explanation and context.
+"
+" footer:
+"
+" The footer is optional and is used to reference issue tracker IDs.
+
 
 
 ""
diff --git a/doc/SpaceVim.txt b/doc/SpaceVim.txt
index fbd65fcb0..4f60353f0 100644
--- a/doc/SpaceVim.txt
+++ b/doc/SpaceVim.txt
@@ -212,8 +212,10 @@ CONTENTS                                                   *SpaceVim-contents*
       15. vim#command...............................|SpaceVim-api-vim-command|
       16. vim#compatible.........................|SpaceVim-api-vim-compatible|
       17. vim#message...............................|SpaceVim-api-vim-message|
-  9. FAQ........................................................|SpaceVim-faq|
-  10. Changelog...........................................|SpaceVim-changelog|
+  9. Development................................................|SpaceVim-dev|
+      1. commit-style-guide..................|SpaceVim-dev-commit-style-guide|
+  10. FAQ.......................................................|SpaceVim-faq|
+  11. Changelog...........................................|SpaceVim-changelog|
 
 ==============================================================================
 INTRODUCTION                                                  *SpaceVim-intro*
@@ -4677,6 +4679,62 @@ echo({hi}, {msg})
 
   print message with {hi} highlight group.
 
+==============================================================================
+DEVELOPMENT                                                     *SpaceVim-dev*
+
+
+SpaceVim is a joint effort of all contributors. We encourage you to
+participate in SpaceVim's development. We have some guidelines that we need
+all contributors to follow.
+
+==============================================================================
+COMMIT-STYLE-GUIDE                           *SpaceVim-dev-commit-style-guide*
+
+A git commit message consists a three distinct parts separated by black line.
+>
+  Type (scope): Subject
+
+  body
+
+  footer
+<
+types:
+
+`feat`: a new feature
+`fix`: a bug fix
+`change`: no backward compatible changes
+`docs`: changes to documentation
+`style`: formatting, missing semi colons, etc; no code change
+`refactor`: refactoring production code
+`test`: adding tests, refactoring test; no production code change
+`chore`: updating build tasks, package manager configs, etc; no production
+  code change
+
+scopes:
+
+`api`: files in `autoload/SpaceVim/api/` and `docs/api/` directory
+`layer`: files in `autoload/SpaceVim/layers/` and `docs/layers/` directory
+`plugin`: files in `autoload/SpaceVim/plugins/` directory
+`bundle`: files in `bundle/` directory
+`core`: other files in this repository
+
+subject:
+
+Subjects should be no greater than 50 characters, should begin with a capital
+letter and do not end with a period.
+
+Use an imperative tone to describe what a commit does, rather than what it
+did. For example, use change; not changed or changes.
+
+body:
+
+Not all commits are complex enough to warrant a body, therefore it is optional
+and only used when a commit requires a bit of explanation and context.
+
+footer:
+
+The footer is optional and is used to reference issue tracker IDs.
+
 ==============================================================================
 FAQ                                                             *SpaceVim-faq*