浏览代码

Docs: Updated commit message format includes package names.

Marek Lewandowski 5 年之前
父节点
当前提交
96fe4abaf4
共有 1 个文件被更改,包括 7 次插入1 次删除
  1. 7 1
      docs/framework/guides/contributing/git-commit-message-convention.md

+ 7 - 1
docs/framework/guides/contributing/git-commit-message-convention.md

@@ -18,7 +18,7 @@ Every commit made *directly* to the `master` branch must follow the below conven
 Commit message template:
 
 ```
-Type: A short sentence about the commit. Closes #XXX.
+Type (package-name, other-package-name): A short sentence about the commit. Closes #XXX.
 
 Optional description.
 
@@ -51,6 +51,12 @@ Each commit can contain additional notes which will be inserted into the changel
 
 If any visible change contains the `BREAKING CHANGE` note, the next release will be marked as `major` automatically.
 
+### Package name
+
+Most commits are related to one or more packages. Each affected package should be listed in parenthesis following the commit type.
+
+It is, however, possible to skip this part if five or more packages are affected.
+
 ### Example commits
 
 A new feature without any breaking changes.