Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] Add documents. Rolling.... #572

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[Docs] Add documents. Rolling.... #572

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions docs/how_to_contribute.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down