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

Coding guideline: Add error checking section #614

Merged
merged 3 commits into from
Aug 11, 2020
Merged

Coding guideline: Add error checking section #614

merged 3 commits into from
Aug 11, 2020

Conversation

kevindiu
Copy link
Contributor

@kevindiu kevindiu commented Aug 6, 2020 •
edited
Loading

Description:

This PR add a error checking section to the coding guideline.

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
Copy link

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

Score: 0.89

Best reviewed: commit by commit

Optimal code review plan

     add error checking section

     fix grammar

     fix comments

Powered by Pull Assistant. Last update 5d70026 ... 5666305. Read the comment docs.

@kevindiu kevindiu requested a review from hlts2 August 6, 2020 09:36
@vdaas-ci
Copy link
Collaborator

vdaas-ci commented Aug 6, 2020

[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

@kevindiu kevindiu added the team/set SET team label Aug 6, 2020
hlts2
hlts2 previously approved these changes Aug 6, 2020
View reviewed changes
Copy link
Collaborator

@hlts2 hlts2 left a comment

Choose a reason for hiding this comment

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

LGTM

@kevindiu
Copy link
Contributor Author

kevindiu commented Aug 7, 2020

I found that the section name Method is wrong, it should be Function.
https://github.com/vdaas/vald/blob/af55ed968ae030987586e67775ee30619cd9eff5/docs/contributing/coding-style.md#methods
@hlts2 @vankichi what do you think?

@vankichi
Copy link
Contributor

Method and Function may be correct?

@hlts2
Copy link
Collaborator

hlts2 commented Aug 11, 2020

@kevindiu

I think this section is correct.
Because Method is a function associated with a "type" and Functions are general functions (starting with func and no associated with a "type")

cc: @vankichi

@kevindiu
Copy link
Contributor Author

@hlts2 thank you for your comment.
than should we rename the Method section to Method & Function?

hlts2
hlts2 previously approved these changes Aug 11, 2020
View reviewed changes
Copy link
Collaborator

@hlts2 hlts2 left a comment

Choose a reason for hiding this comment

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

LGTM

@kevindiu kevindiu requested a review from vankichi August 11, 2020 05:57
@kevindiu kevindiu marked this pull request as ready for review August 11, 2020 05:57
vankichi
vankichi previously approved these changes Aug 11, 2020
View reviewed changes
@vankichi
Copy link
Contributor

/rebase
/format
/approve

@vdaas-ci
Copy link
Collaborator

[REBASE] Rebase triggered by vankichi for branch: documentation/contributing/coding-style

@vdaas-ci vdaas-ci dismissed stale reviews from vankichi and hlts2 via 5666305 August 11, 2020 06:21
@vdaas-ci vdaas-ci force-pushed the documentation/contributing/coding-style branch from 2cfaae6 to 5666305 Compare August 11, 2020 06:21
@vdaas-ci
Copy link
Collaborator

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

vdaas-ci
vdaas-ci approved these changes Aug 11, 2020
View reviewed changes
Copy link
Collaborator

@vdaas-ci vdaas-ci left a comment

Choose a reason for hiding this comment

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

[APPROVED] This PR is approved by vankichi.

@vankichi vankichi merged commit 4a499fb into master Aug 11, 2020
@vankichi vankichi deleted the documentation/contributing/coding-style branch August 11, 2020 06:42
@vdaas-ci vdaas-ci mentioned this pull request Sep 2, 2020
Merged
18 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments

@vdaas-ci vdaas-ci vdaas-ci approved these changes

@hlts2 hlts2 hlts2 left review comments

@vankichi vankichi vankichi left review comments

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

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