[Coding guideline] Add implementation and grouping section #641

kevindiu · 2020-08-25T06:53:29Z

Description:

This PR update the coding guideline and create 2 new section to cover the following things:

add example of implementation for functional option
grouping type declaration
order of declaration

Please refer to this task ticket for this PR:
https://github.com/vdaas/vald/projects/3#card-44245759

Related Issue:

How Has This Been Tested?:

Environment:

Go Version: 1.14.4
Docker Version: 19.03.8
Kubernetes Version: 1.18.2
NGT Version: 1.12.0

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 · 2020-08-25T06:53:31Z

Best reviewed: commit by commit

Optimal code review plan (2 commits squashed)

update coding guideline

apply suggestion

fix

fix ... apply suggestion

Squashed 2 commits:

fix

apply suggestion

fix

Powered by Pull Assistant. Last update 95746ac ... 45ff9ba. Read the comment docs.

vdaas-ci · 2020-08-25T06:53:45Z

[CHATOPS:HELP] ChatOps commands.

🙆‍♀️ /approve - approve
💌 /changelog - add changelog comment
🍱 /format - format codes and add licenses
✅ /gen-test - generate test codes
🏷️ /label - add labels
⏪ /rebase - rebase master

github-actions

Remaining comments which cannot be posted as a review comment to avoid GitHub Rate Limit

LanguageTool

docs/contributing/coding-style.md|460 col 8| Loose punctuation mark. (UNLIKELY_OPENING_PUNCTUATION[1])
Suggestions: ``
Rule: https://community.languagetool.org/rule/show/UNLIKELY_OPENING_PUNCTUATION?lang=en-US&subId=1
Category: PUNCTUATION
docs/contributing/coding-style.md|462 col 3| Don't put a space before the closing parenthesis (COMMA_PARENTHESIS_WHITESPACE)
Suggestions: }
Rule: https://community.languagetool.org/rule/show/COMMA_PARENTHESIS_WHITESPACE?lang=en-US
Category: TYPOGRAPHY

docs/contributing/coding-style.md

hlts2

LGTM

docs/contributing/coding-style.md

hlts2

LGTM

docs/contributing/coding-style.md

hlts2

LGTMed

vankichi

LGTM

github-actions · 2020-08-26T08:33:48Z

docs/contributing/coding-style.md

-```
-
-Instead of this style.
+addr := conn.LocalAddr()


[LanguageTool] _{reported by reviewdog 🐶}
Add a space between sentences (SENTENCE_WHITESPACE)
Suggestions: LocalAddr
Rule: https://community.languagetool.org/rule/show/SENTENCE_WHITESPACE?lang=en-US
Category: TYPOGRAPHY

hlts2

sorry I overlooked this
LGTMed

vankichi · 2020-08-27T02:58:20Z

docs/contributing/coding-style.md

+<table>
+<thead><tr><th>Bad</th><th>Good</th></tr></thead>
+<tbody><tr><td>
+
 ```go
-// good
 if err := fn(); err != nil {
    // handle error
 }
 ```

-Instead of this style.
+</td><td>

 ```go
-// bad
 err := fn()
 if err != nil {
    // handle error
 }
 ```


kpango · 2020-08-27T03:05:08Z

/rebase
/format

vdaas-ci · 2020-08-27T03:05:41Z

[REBASE] Rebase triggered by kpango for branch: documentation/coding_guideline/func_option_and_grouping

vdaas-ci · 2020-08-27T03:06:34Z

[FORMAT] Updating license headers and formatting go codes triggered by kpango.

github-actions · 2020-08-27T03:08:07Z

docs/contributing/coding-style.md

-// good
-if err := fn(); err != nil {
+err := fn()
+if err != nil {


[LanguageTool] _{reported by reviewdog 🐶}
Don't put a space after the opening parenthesis (COMMA_PARENTHESIS_WHITESPACE)
Suggestions: {
Rule: https://community.languagetool.org/rule/show/COMMA_PARENTHESIS_WHITESPACE?lang=en-US
Category: TYPOGRAPHY

github-actions · 2020-08-27T03:08:07Z

docs/contributing/coding-style.md

-// bad
-err := fn()
-if err != nil {
+if err := fn(); err != nil {


[LanguageTool] _{reported by reviewdog 🐶}
Don't put a space after the opening parenthesis (COMMA_PARENTHESIS_WHITESPACE)
Suggestions: {
Rule: https://community.languagetool.org/rule/show/COMMA_PARENTHESIS_WHITESPACE?lang=en-US
Category: TYPOGRAPHY

kpango

LGTM

github-actions · 2020-08-27T03:13:53Z

docs/contributing/coding-style.md

-// good
-conn, err := net.Dial("tcp", "localhost:80")
-if err != nil {
+if conn, err := net.Dial("tcp", "localhost:80");  err != nil {


[LanguageTool] _{reported by reviewdog 🐶}
Add a space between sentences (SENTENCE_WHITESPACE)
Suggestions: Dial
Rule: https://community.languagetool.org/rule/show/SENTENCE_WHITESPACE?lang=en-US
Category: TYPOGRAPHY

github-actions · 2020-08-27T03:13:54Z

docs/contributing/coding-style.md

-// good
-conn, err := net.Dial("tcp", "localhost:80")
-if err != nil {
+if conn, err := net.Dial("tcp", "localhost:80");  err != nil {


[LanguageTool] _{reported by reviewdog 🐶}
Possible typo: you repeated a whitespace (WHITESPACE_RULE)
Suggestions:
Rule: https://community.languagetool.org/rule/show/WHITESPACE_RULE?lang=en-US
Category: TYPOGRAPHY

github-actions · 2020-08-27T03:13:54Z

docs/contributing/coding-style.md

-// good
-conn, err := net.Dial("tcp", "localhost:80")
-if err != nil {
+if conn, err := net.Dial("tcp", "localhost:80");  err != nil {


[LanguageTool] _{reported by reviewdog 🐶}
Don't put a space after the opening parenthesis (COMMA_PARENTHESIS_WHITESPACE)
Suggestions: {
Rule: https://community.languagetool.org/rule/show/COMMA_PARENTHESIS_WHITESPACE?lang=en-US
Category: TYPOGRAPHY

github-actions · 2020-08-27T03:13:54Z

docs/contributing/coding-style.md

    // handle error
+} else {


[LanguageTool] _{reported by reviewdog 🐶}
Don't put a space after the opening parenthesis (COMMA_PARENTHESIS_WHITESPACE)
Suggestions: {
Rule: https://community.languagetool.org/rule/show/COMMA_PARENTHESIS_WHITESPACE?lang=en-US
Category: TYPOGRAPHY

github-actions · 2020-08-27T03:13:54Z

docs/contributing/coding-style.md

    // handle error
+} else {
+    // use the conn


[LanguageTool] _{reported by reviewdog 🐶}
After 'the', do not use a verb. Make sure that the spelling of 'conn' is correct. If 'conn' is the first word in a compound adjective, use a hyphen between the two words. Note: This error message can occur if you use a verb as a noun, and the word is not a noun in standard English. (A_INFINITIVE[1])
Rule: https://community.languagetool.org/rule/show/A_INFINITIVE?lang=en-US&subId=1
Category: GRAMMAR

github-actions · 2020-08-27T03:13:54Z

docs/contributing/coding-style.md

    // handle error
+} else {
+    // use the conn


[LanguageTool] _{reported by reviewdog 🐶}
Don't put a space before the closing parenthesis (COMMA_PARENTHESIS_WHITESPACE)
Suggestions: }
Rule: https://community.languagetool.org/rule/show/COMMA_PARENTHESIS_WHITESPACE?lang=en-US
Category: TYPOGRAPHY

github-actions · 2020-08-27T03:13:54Z

docs/contributing/coding-style.md


 ```go
-// bad
-if conn, err := net.Dial("tcp", "localhost:80");  err != nil {
+conn, err := net.Dial("tcp", "localhost:80")


[LanguageTool] _{reported by reviewdog 🐶}
Add a space between sentences (SENTENCE_WHITESPACE)
Suggestions: Dial
Rule: https://community.languagetool.org/rule/show/SENTENCE_WHITESPACE?lang=en-US
Category: TYPOGRAPHY

github-actions · 2020-08-27T03:13:54Z

docs/contributing/coding-style.md

-// bad
-if conn, err := net.Dial("tcp", "localhost:80");  err != nil {
+conn, err := net.Dial("tcp", "localhost:80")
+if err != nil {


[LanguageTool] _{reported by reviewdog 🐶}
Don't put a space after the opening parenthesis (COMMA_PARENTHESIS_WHITESPACE)
Suggestions: {
Rule: https://community.languagetool.org/rule/show/COMMA_PARENTHESIS_WHITESPACE?lang=en-US
Category: TYPOGRAPHY

github-actions · 2020-08-27T03:13:54Z

docs/contributing/coding-style.md

 }
+// use the conn


[LanguageTool] _{reported by reviewdog 🐶}
After 'the', do not use a verb. Make sure that the spelling of 'conn' is correct. If 'conn' is the first word in a compound adjective, use a hyphen between the two words. Note: This error message can occur if you use a verb as a noun, and the word is not a noun in standard English. (A_INFINITIVE[1])
Rule: https://community.languagetool.org/rule/show/A_INFINITIVE?lang=en-US&subId=1
Category: GRAMMAR

github-actions bot added size/L type/documentation priority/low labels Aug 25, 2020

kevindiu requested a review from hlts2 August 25, 2020 06:54

kevindiu added the team/set SET team label Aug 25, 2020

github-actions bot reviewed Aug 25, 2020

View reviewed changes

hlts2 requested changes Aug 25, 2020

View reviewed changes

docs/contributing/coding-style.md Outdated Show resolved Hide resolved

docs/contributing/coding-style.md Outdated Show resolved Hide resolved

docs/contributing/coding-style.md Outdated Show resolved Hide resolved

docs/contributing/coding-style.md Outdated Show resolved Hide resolved

github-actions bot reviewed Aug 25, 2020

View reviewed changes

docs/contributing/coding-style.md Show resolved Hide resolved

docs/contributing/coding-style.md Show resolved Hide resolved

docs/contributing/coding-style.md Show resolved Hide resolved

docs/contributing/coding-style.md Show resolved Hide resolved

hlts2 reviewed Aug 25, 2020

View reviewed changes

docs/contributing/coding-style.md Show resolved Hide resolved

github-actions bot reviewed Aug 25, 2020

View reviewed changes

docs/contributing/coding-style.md Show resolved Hide resolved

hlts2 previously approved these changes Aug 25, 2020

View reviewed changes

vankichi reviewed Aug 25, 2020

View reviewed changes

vankichi added the status/need-fix label Aug 25, 2020

kevindiu dismissed hlts2’s stale review via 399893e August 26, 2020 00:51

kevindiu removed the status/need-fix label Aug 26, 2020

hlts2 approved these changes Aug 26, 2020

View reviewed changes

hlts2 requested changes Aug 26, 2020

View reviewed changes

docs/contributing/coding-style.md Outdated Show resolved Hide resolved

hlts2 previously approved these changes Aug 26, 2020

View reviewed changes

kevindiu requested a review from vankichi August 26, 2020 07:34

vankichi previously approved these changes Aug 26, 2020

View reviewed changes

kevindiu dismissed stale reviews from vankichi and hlts2 via d360c59 August 26, 2020 08:12

vankichi previously approved these changes Aug 26, 2020

View reviewed changes

kevindiu dismissed vankichi’s stale review via e1a7428 August 26, 2020 08:31

github-actions bot reviewed Aug 26, 2020

View reviewed changes

rinx previously approved these changes Aug 26, 2020

View reviewed changes

kevindiu dismissed rinx’s stale review via fa98437 August 27, 2020 01:07

kevindiu requested a review from vankichi August 27, 2020 01:17

kevindiu dismissed hlts2’s stale review via 2e3fdcb August 27, 2020 02:29

kevindiu requested review from hlts2 and vankichi August 27, 2020 02:30

hlts2 previously approved these changes Aug 27, 2020

View reviewed changes

vankichi reviewed Aug 27, 2020

View reviewed changes

kevindiu dismissed hlts2’s stale review via 73eab54 August 27, 2020 03:04

kevindiu added 13 commits August 27, 2020 03:05

update coding guideline

95746ac

apply suggestion

5eb3d9b

fix

e040f66

fix

56c7343

fix

af48a1c

fix

71ccd32

apply suggestion

3fe7d37

fix

beb1155

fix

5e17b53

fix

43c7cbe

fix

b89f173

fix

4f440a4

fix

4fec1e9

vdaas-ci force-pushed the documentation/coding_guideline/func_option_and_grouping branch from 73eab54 to 4fec1e9 Compare August 27, 2020 03:05

github-actions bot reviewed Aug 27, 2020

View reviewed changes

fix

45ff9ba

kpango approved these changes Aug 27, 2020

View reviewed changes

kpango merged commit cfcf27a into master Aug 27, 2020

kpango deleted the documentation/coding_guideline/func_option_and_grouping branch August 27, 2020 03:13

github-actions bot reviewed Aug 27, 2020

View reviewed changes

vdaas-ci mentioned this pull request Sep 2, 2020

[patch] update deps #660

Merged

18 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Coding guideline] Add implementation and grouping section #641

[Coding guideline] Add implementation and grouping section #641

kevindiu commented Aug 25, 2020 •

edited

Loading

pull-assistant bot commented Aug 25, 2020 •

edited

Loading

vdaas-ci commented Aug 25, 2020

github-actions bot left a comment

hlts2 left a comment

hlts2 left a comment

hlts2 left a comment

vankichi left a comment

github-actions bot Aug 26, 2020

hlts2 left a comment •

edited

Loading

vankichi Aug 27, 2020

kpango commented Aug 27, 2020

vdaas-ci commented Aug 27, 2020

vdaas-ci commented Aug 27, 2020

github-actions bot Aug 27, 2020

github-actions bot Aug 27, 2020

kpango left a comment

github-actions bot Aug 27, 2020

github-actions bot Aug 27, 2020

github-actions bot Aug 27, 2020

github-actions bot Aug 27, 2020

github-actions bot Aug 27, 2020

github-actions bot Aug 27, 2020

github-actions bot Aug 27, 2020

github-actions bot Aug 27, 2020

github-actions bot Aug 27, 2020

[Coding guideline] Add implementation and grouping section #641

[Coding guideline] Add implementation and grouping section #641

Conversation

kevindiu commented Aug 25, 2020 • edited Loading

Description:

Related Issue:

How Has This Been Tested?:

Environment:

Types of changes:

Changes to Core Features:

Checklist:

pull-assistant bot commented Aug 25, 2020 • edited Loading

vdaas-ci commented Aug 25, 2020

github-actions bot left a comment

Choose a reason for hiding this comment

hlts2 left a comment

Choose a reason for hiding this comment

hlts2 left a comment

Choose a reason for hiding this comment

hlts2 left a comment

Choose a reason for hiding this comment

vankichi left a comment

Choose a reason for hiding this comment

github-actions bot Aug 26, 2020

Choose a reason for hiding this comment

hlts2 left a comment • edited Loading

Choose a reason for hiding this comment

vankichi Aug 27, 2020

Choose a reason for hiding this comment

kpango commented Aug 27, 2020

vdaas-ci commented Aug 27, 2020

vdaas-ci commented Aug 27, 2020

github-actions bot Aug 27, 2020

Choose a reason for hiding this comment

github-actions bot Aug 27, 2020

Choose a reason for hiding this comment

kpango left a comment

Choose a reason for hiding this comment

github-actions bot Aug 27, 2020

Choose a reason for hiding this comment

github-actions bot Aug 27, 2020

Choose a reason for hiding this comment

github-actions bot Aug 27, 2020

Choose a reason for hiding this comment

github-actions bot Aug 27, 2020

Choose a reason for hiding this comment

github-actions bot Aug 27, 2020

Choose a reason for hiding this comment

github-actions bot Aug 27, 2020

Choose a reason for hiding this comment

github-actions bot Aug 27, 2020

Choose a reason for hiding this comment

github-actions bot Aug 27, 2020

Choose a reason for hiding this comment

github-actions bot Aug 27, 2020

Choose a reason for hiding this comment

kevindiu commented Aug 25, 2020 •

edited

Loading

pull-assistant bot commented Aug 25, 2020 •

edited

Loading

hlts2 left a comment •

edited

Loading