From 2ba631e54bd9ecbeea776b41228cb8d318bf3d39 Mon Sep 17 00:00:00 2001 From: vankichi Date: Mon, 7 Sep 2020 18:59:35 +0900 Subject: [PATCH 1/4] :pencil: update contributing guide Signed-off-by: vankichi --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aa0e57f1ec..f1e1fe05f8 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 @@ -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 "-". From 314220e9598a91c57b754df9ce9b149547b23e0d Mon Sep 17 00:00:00 2001 From: vankichi Date: Wed, 9 Sep 2020 15:21:19 +0900 Subject: [PATCH 2/4] :pencil: fix Signed-off-by: vankichi --- CONTRIBUTING.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f1e1fe05f8..9d08fe85a2 100755 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -121,8 +121,10 @@ 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. please use [a-zA-Z0-9] and hyphen as characters, do not use any other characters. +| Field | Explanation | nameing rule | +| :--- | :--- | :--- | +| type | type represents the PR type | feature, bug, refactoring, benchmark, security, documentation, dependencies, ci, ... | +| area | this field represents area of context | gateway, meta, manager-backup, manager-replication, ... | +| description | summarized description of your branch | Branch description. The 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 "-". From 0d55f1425a8b4b796c18a64cd4a138d645050045 Mon Sep 17 00:00:00 2001 From: vankichi Date: Wed, 9 Sep 2020 16:16:19 +0900 Subject: [PATCH 3/4] :pencil: fix Signed-off-by: vankichi --- CONTRIBUTING.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9d08fe85a2..40257fa74a 100755 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -121,10 +121,12 @@ Your pull request is much more likely to be accepted if: Name your branches with prefixes: `[type]/[area]/[description]` -| Field | Explanation | nameing rule | -| :--- | :--- | :--- | -| type | type represents the PR type | feature, bug, refactoring, benchmark, security, documentation, dependencies, ci, ... | -| area | this field represents area of context | gateway, meta, manager-backup, manager-replication, ... | -| description | summarized description of your branch | Branch description. The description must be hyphenated. Please use [a-zA-Z0-9] and hyphen as characters, do not use any other characters. | +| Field | Explanation | Naming Rule | +| :--- | :--- | :--- | +| type | The PR type | feature, bug, refactoring, benchmark, security, documentation, dependencies, ci, ... | +| area | Area of context | gateway, meta, manager-backup, manager-replication, ... | +| 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`. From 921790e6d1b36ce640153bca3599941b09678f77 Mon Sep 17 00:00:00 2001 From: vankichi Date: Thu, 10 Sep 2020 10:32:03 +0900 Subject: [PATCH 4/4] :pencil: fix Signed-off-by: vankichi --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 40257fa74a..3cedb34a48 100755 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -123,8 +123,8 @@ Name your branches with prefixes: `[type]/[area]/[description]` | Field | Explanation | Naming Rule | | :--- | :--- | :--- | -| type | The PR type | feature, bug, refactoring, benchmark, security, documentation, dependencies, ci, ... | -| area | Area of context | gateway, meta, manager-backup, manager-replication, ... | +| 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 "-".