Skip to content

Commit

Permalink
📝 update contributing guide
Browse files Browse the repository at this point in the history
Signed-off-by: vankichi <[email protected]>
  • Loading branch information
vankichi authored and actions-user committed Sep 11, 2020
1 parent ca48e44 commit 2ba631e
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,10 @@ Follow these steps to make a contribution to any of our open source repositories
1. Ensure that you have completed our [CLA Agreement](https://cla-assistant.io/vdaas/vald)
2. Set your name and email (these should match the information on your submitted CLA)

git config --global user.name "Firstname Lastname"
git config --global user.email "[email protected]"
```bash
git config --global user.name "Firstname Lastname"
git config --global user.email "[email protected]"
```


### How to contributing source code
Expand Down Expand Up @@ -121,6 +123,6 @@ Name your branches with prefixes: `[type]/[area]/[description]`

* `type` = feature, bug, refactoring, benchmark, security, documentation, dependencies, ci, ...
* `area` (\*) = gateway, meta, manager-backup, manager-replication, ...
* `description` = branch description. description must be hyphenated.
* `description` = branch description. description must be hyphenated. please use [a-zA-Z0-9] and hyphen as characters, do not use any other characters.

(\*) If you changed multiple areas, please list up each area with "-".

0 comments on commit 2ba631e

Please sign in to comment.