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

Contribute document #390

Merged
merged 9 commits into from
Jun 2, 2020
Merged

Contribute document #390

merged 9 commits into from
Jun 2, 2020

Conversation

hlts2
Copy link
Collaborator

@hlts2 hlts2 commented May 20, 2020 •
edited
Loading

Description:

I added contents to report the issue in the CONTRIDUTE.md.
The following is table of contents.

  • Contributing Issue
    • Bug Report
    • Proposal
    • Feature Request
    • Security Issue Report
  • Contributing Source Code
    • Before contributing source code
    • How to Contributing source code
    • Branch naming convention

Related Issue:

How Has This Been Tested?:

Environment:

  • Golang Version: 1.14.3
  • Docker Version: 19.03.8
  • Kubernetes Version: 1.18.2
  • NGT Version: 1.11.5

Types of changes:

  • Bug fix [type/bug]
  • New feature [type/feature]
  • Add tests [type/test]
  • Security related changes [type/security]
  • Add documents [type/documentation]
  • Refactoring [type/refactoring]
  • Update dependencies [type/dependency]
  • Update benchmarks and performances [type/bench]
  • Update CI [type/ci]

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you successfully ran tests with your changes locally?

Checklist:

  • I have read the CONTRIBUTING document.
  • I have checked open Pull Requests for the similar feature or fixes?
  • I have added tests and benchmarks to cover my changes.
  • I have ensured all new and existing tests passed.
  • I have commented my code, particularly in hard-to-understand areas
  • I have updated the documentation accordingly.

@pull-assistant
Copy link

pull-assistant bot commented May 20, 2020 •
edited
Loading

Score: 0.54

Best reviewed: commit by commit

Optimal code review plan (3 warnings, 2 commits squashed)

add: issue report detail

CONTRIBUTING.md 42% changes removed in fix: apply suggestio...

add: issue report co... ... fix: apply suggestio...

Squashed 2 commits:

     fix: apply suggestion

fix: subsection title

CONTRIBUTING.md 50% changes removed in fix: apply suggestio...

fix: apply suggestion

CONTRIBUTING.md 75% changes removed in fix: apply suggestio...

     fix: apply suggestion

     fix: apply suggestion

     fix: apply suggestion

Powered by Pull Assistant. Last update 7e44afb ... 4f08076. Read the comment docs.

@hlts2 hlts2 changed the title Contribute document [Draft] Contribute document May 21, 2020
@hlts2
Copy link
Collaborator Author

hlts2 commented May 21, 2020

/rebase

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by hlts2 for branch: documentation/contribute_doc

@vdaas-ci vdaas-ci force-pushed the documentation/contribute_doc branch from 391d924 to cd1f633 Compare May 21, 2020 04:55
vankichi
vankichi reviewed May 22, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@vankichi
Copy link
Contributor

It looks there are duplicated sentences especially comparing the "Filling Issue" section and each issue section.
please check each section again and consider which is the best way to make a readable document and easy to understand for users.

@hlts2
Copy link
Collaborator Author

hlts2 commented May 25, 2020

/rebase

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by hlts2 for branch: documentation/contribute_doc

@vdaas-ci vdaas-ci force-pushed the documentation/contribute_doc branch from cd1f633 to c2c9d85 Compare May 25, 2020 05:17
kevindiu
kevindiu suggested changes May 25, 2020
View reviewed changes
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@kevindiu
Copy link
Contributor

LGTM

@hlts2
Copy link
Collaborator Author

hlts2 commented May 26, 2020

/rebase

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by hlts2 for branch: documentation/contribute_doc

@vdaas-ci
Copy link
Collaborator

[REBASE] Failed to rebase.

@hlts2 hlts2 force-pushed the documentation/contribute_doc branch from fe8ed35 to 196a446 Compare May 26, 2020 07:09
@hlts2
Copy link
Collaborator Author

hlts2 commented May 26, 2020

/rebase

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by hlts2 for branch: documentation/contribute_doc

vankichi
vankichi reviewed May 27, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
vankichi
vankichi reviewed May 27, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
vankichi
vankichi reviewed May 27, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
@hlts2
Copy link
Collaborator Author

hlts2 commented May 27, 2020

/rebase

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by hlts2 for branch: documentation/contribute_doc

@vdaas-ci vdaas-ci force-pushed the documentation/contribute_doc branch from 196a446 to fa4f856 Compare May 27, 2020 02:49
kevindiu
kevindiu reviewed May 27, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@hlts2 hlts2 marked this pull request as ready for review May 28, 2020 05:38
@hlts2 hlts2 changed the title [Draft] Contribute document Contribute document May 28, 2020
@rinx
Copy link
Contributor

rinx commented May 29, 2020

@kevindiu Thanks 😄 your suggestion seems better than before. please include it to this PR. 👍

@hlts2
Copy link
Collaborator Author

hlts2 commented Jun 1, 2020

/rebase

@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Jun 1, 2020

[REBASE] Rebase triggered by hlts2 for branch: documentation/contribute_doc

@vdaas-ci vdaas-ci force-pushed the documentation/contribute_doc branch from 4dfeb1a to dfc741d Compare June 1, 2020 00:08
@kevindiu
Copy link
Contributor

kevindiu commented Jun 1, 2020

LGTM

kevindiu
kevindiu reviewed Jun 1, 2020
View reviewed changes
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
@hlts2
Copy link
Collaborator Author

hlts2 commented Jun 1, 2020

/rebase

@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Jun 1, 2020

[REBASE] Rebase triggered by hlts2 for branch: documentation/contribute_doc

@vdaas-ci vdaas-ci force-pushed the documentation/contribute_doc branch from 96d8833 to 55794cb Compare June 1, 2020 08:08
vankichi
vankichi previously approved these changes Jun 1, 2020
View reviewed changes
Copy link
Contributor

@vankichi vankichi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
/approve
/rebase
/format

@vankichi
Copy link
Contributor

vankichi commented Jun 2, 2020

/rebase

@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Jun 2, 2020

[REBASE] Rebase triggered by vankichi for branch: documentation/contribute_doc

hlts2 added 9 commits June 2, 2020 01:05
@hlts2 @actions-user
add: issue report detail
7e44afb 
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@hlts2 @actions-user
add: issue report contents
c583e2c 
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@hlts2 @actions-user
fix: apply suggestion
958cdb3 
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@hlts2 @actions-user
fix: apply suggestion
cdb4b21 
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@hlts2 @actions-user
fix: subsection title
6b894ce 
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@hlts2 @actions-user
fix: apply suggestion
680492b 
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@hlts2 @actions-user
fix: apply suggestion
4cf815f 
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@hlts2 @actions-user
fix: apply suggestion
8a87851 
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@hlts2 @actions-user
fix: apply suggestion
4f08076 
Signed-off-by: hlts2 <hiroto.funakoshi.hiroto@gmail.com>
@vdaas-ci vdaas-ci force-pushed the documentation/contribute_doc branch from 9475ecb to 4f08076 Compare June 2, 2020 01:05
vankichi
vankichi approved these changes Jun 2, 2020
View reviewed changes
Copy link
Contributor

@vankichi vankichi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/approve

@kevindiu
Copy link
Contributor

kevindiu commented Jun 2, 2020

/rebase

@kevindiu kevindiu self-requested a review June 2, 2020 01:18
@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Jun 2, 2020

[REBASE] Rebase triggered by kevindiu for branch: documentation/contribute_doc

@vankichi vankichi merged commit 07788fe into master Jun 2, 2020
@vankichi vankichi deleted the documentation/contribute_doc branch June 2, 2020 02:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vankichi vankichi vankichi approved these changes

@kevindiu kevindiu kevindiu approved these changes

Assignees
No one assigned
Labels
priority/low size/M type/documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@hlts2 @vdaas-ci @vankichi @kevindiu @rinx