From 38c5e3e87bc8b3d49df75230e743b970ea2fcdf6 Mon Sep 17 00:00:00 2001
From: Jinjie Li <45286479+Li-Jinjie@users.noreply.github.com>
Date: Tue, 7 Nov 2023 19:19:54 +0900
Subject: [PATCH] [Docs] add instructions of naming rules for one branch

---
 docs/how_to_contribute.md | 19 +++++++++++++++++--
 1 file changed, 17 insertions(+), 2 deletions(-)

diff --git a/docs/how_to_contribute.md b/docs/how_to_contribute.md
index e9dde7bef..f11da4a67 100644
--- a/docs/how_to_contribute.md
+++ b/docs/how_to_contribute.md
@@ -7,10 +7,25 @@
 3. once you finish your development, make a pull request to the original repository
 4. the original repository maintainer will review your pull request and merge it if it is OK
 
+## Naming Rule for Branches
+
+We use the following naming rule for branches:
+
+If you are developing a new robot, please name your branch as `develop/robot_name`.
+
+If you are developing a new algorithm,
+please name your branch as `develop/algorithm_name`.
+
+If you want to develop a sub-function of an algorithm, please name your branch as `develop/algorithm_name_subfunction`.
+
+If you want to fix a bug, please name your branch as `fix/bug_name`.
+
+If your branch is ready to pull request, please name your branch as `PR/function`.
+
 ## Code Style
 
-We use Clang-format to format the C++ code, and use black to format the Python code. 
-Pre-commit, the format plugin, will run automatically before each commit. The specific function has been written in 
+We use Clang-format to format the C++ code, and use black to format the Python code.
+Pre-commit, the format plugin, will run automatically before each commit. The specific function has been written in
 .pre-commit-config.yaml. To activate this plugin, please run the following command in terminal and root directory:
 
 ```bash