diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aa0e57f1ec..3cedb34a48 100755 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 "your_email@example.com" + ```bash + git config --global user.name "Firstname Lastname" + git config --global user.email "your_email@example.com" + ``` ### How to contributing source code @@ -119,8 +121,12 @@ Your pull request is much more likely to be accepted if: 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. +| Field | Explanation | Naming Rule | +| :--- | :--- | :--- | +| type | The PR type | The type of PR can be feature, bug, refactoring, benchmark, security, documentation, dependencies, ci, test, or etc... | +| area | Area of context | The area of PR can be gateway, meta, manager-backup, manager-replication, or etc... | +| description | Summarized description of your branch | The description must be hyphenated. Please use [a-zA-Z0-9] and hyphen as characters, and do not use any other characters. | (\*) If you changed multiple areas, please list up each area with "-". + +For example, when you add new feature for internal/servers, the name of branch will be `feature/internal/add-newfeature-for-servers`.