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

Jump to bottom

update contributing guide #678

Merged
merged 4 commits into from
Sep 14, 2020
Merged

update contributing guide #678

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2ba631e
:pencil: update contributing guide
vankichi Sep 7, 2020
314220e
:pencil: fix
vankichi Sep 9, 2020
0d55f14
:pencil: fix
vankichi Sep 9, 2020
921790e
:pencil: fix
vankichi Sep 10, 2020
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
16 changes: 11 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
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 "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
Expand Down Expand Up @@ -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... |
vankichi marked this conversation as resolved.
Show resolved Hide resolved
| 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. |

vankichi marked this conversation as resolved.
Show resolved Hide resolved
(\*) 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`.