Merge pull request #127 from andy89923/docs/commit-message

feat: add conventional commit message instruction
free5gc · Apr 26, 2024 · 040cc73 · 040cc73
2 parents a5ceb1e + c8a437d
commit 040cc73
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/docs/guide/contribute.md b/docs/guide/contribute.md
@@ -14,6 +14,10 @@ A issue could be 1. bugs report or 2. feature request, each issue would be assig
 The source code of the free5GC is stored at [https://github.com/free5gc/free5gc](https://github.com/free5gc/free5gc).
 Please follow the [GitHub flow](https://docs.github.com/en/get-started/using-github/github-flow) for collaboration.
 
+> [!NOTE] 
+> Our pull request commit messages must comply with the [**Conventional Commit Message**](https://www.conventionalcommits.org/en/v1.0.0/) format. 
+> This will be checked by the pull request CI action.
+
 
 ## Design Documents
 

diff --git a/docs/guide/index.md b/docs/guide/index.md
@@ -12,7 +12,6 @@
 
 Here are the features on the roadmap. These items are planned to be supported in the near future:
 
-* Charging Function (CHF)
 * Session AMBR in Data Plane
 * Network Exposure Function (NEF)