-
Notifications
You must be signed in to change notification settings - Fork 79
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: apply the suggestion from review
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
- Loading branch information
Showing
1 changed file
with
27 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,40 +1,49 @@ | ||
| # Contacts | ||
| ## [Bug Report](https://github.com/vdaas/vald/issues/new?assignees=&labels=type%2Fbug%2C+priority%2Fmedium%2C+team%2Fcore&template=bug_report.md&title=) | ||
|
|
||
| A bug is a demonstrable problem that is caused by code in the repository. Bug reports are helpful for developers who maintain the Vald project. | ||
| ## Table of Contents | ||
|
|
||
| A good bug report shouldn’t leave others needing to ask you constantly for more information. So could you please try to be as detailed as possible in your bug report? | ||
| - [Bug Report](#Bug-Report) | ||
| - [Proposal](#Proposal) | ||
| - [Feature Request](#Feature-Request) | ||
| - [Security Issue Report](#Security-Issue-Report) | ||
|
|
||
| Things to check before reporting the bug: | ||
| ### Bug Report | ||
|
|
||
| A bug is a demonstrable problem which produce incorrect result or to behave in unintended ways. | ||
| Bug reports are helpful for developers who maintain the Vald project. | ||
|
|
||
| A good bug report shouldn’t leave others needing to ask you for more information constantly. | ||
| Please try to write as detail as possible in your bug report. | ||
|
|
||
| Things to check before reporting a bug: | ||
| - Check your environment | ||
| Bug may occur depending on versions (Go, Docker, Kubernetes, NGT ..etc). | ||
| So please match versions recommended by the Vald project. | ||
| Bug may occur depending on different version of Vald, Kubernetes and etc. | ||
|
|
||
| - Identify the bug | ||
| Developers need to reproduce the bug in the developers environment. | ||
| So please Identify the bug and clarify how it occurs. | ||
| Then please clarify the expected behavior too. | ||
| Also please clarify the expected behavior too. | ||
|
|
||
| - Use the Github issue search | ||
| The bug has already been reported. | ||
| The bug may be reported before. | ||
| So please check the Github issue before reporting. | ||
|
|
||
| ## [Proposal](https://github.com/vdaas/vald/issues/new?assignees=&labels=type%2Ffeature%2C+priority%2Flow%2C+team%2Fcore&template=feature_request.md&title=) | ||
| ### Proposal | ||
|
|
||
| The Vald project’s development process is design-driven. | ||
| The significant change to the library, or architecture must be first discussed, and sometimes formally documented before it can be implemented. | ||
| The proposal is the process for reviewing a proposal and reaching a decision about whether to accept or decline the proposal. | ||
| After the proposal is accepted or declined, please start implementations. | ||
| The significant change to the library, or the architecture be discussed first. | ||
| We may need a detail documentation before you proposal is implemented. | ||
| Your proposal will be reviewed and discussed and decide whether it is accepted or declined. | ||
|
|
||
| ## [Feature Request](https://github.com/vdaas/vald/issues/new?assignees=&labels=type%2Ffeature%2C+priority%2Flow%2C+team%2Fcore&template=feature_request.md&title=) | ||
| ### Feature Request | ||
|
|
||
| Feature request is welcome. | ||
| Before opening an issue, please make sure your idea fits the scope and goals of the project. | ||
| It is up to you to make a strong claim to convince the project maintainers the benefits of the feature. | ||
| Please provide as much detail as possible about the problem and solution associated with the feature request. | ||
| Before opening an issue, please make sure your idea fits the project. | ||
| You can make a strong claim to convince the project maintainers to accept your feature request. | ||
| Please provide the problem and solution associated with the feature request as detail as possible. | ||
|
|
||
| ## [Security Issue Report](https://github.com/vdaas/vald/issues/new?assignees=&labels=type%2Fsecurity%2C+priority%2Fmedium%2C+team%2Fcore%2C+team%2Fsre&template=security_issue_report.md&title=) | ||
| ### Security Issue Report | ||
|
|
||
| The Vald team and community take security bugs in seriously. | ||
| The Vald team and community take serious concern about security issues. | ||
| We appreciate your efforts to responsibly disclose your findings, and will make every effort to acknowledge your contributions. | ||
| We will report security bugs in third-party modules to the person or team maintaining the module. |