kubernetes
/
community
mirror of https://github.com/kubernetes/community.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

coding conventions: simplify sections 

The coding advice section had only one bullet, which is golang specific, so
bump that up into the Go section as a sub-bullet.

Signed-off-by: Tim Pepper <tpepper@vmware.com>
This commit is contained in:
Tim Pepper 2018-01-24 13:48:23 -08:00
parent 292926e324
commit 482b91feef
1 changed files with 3 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
contributors/devel/coding-conventions.md
View File

@ -1,6 +1,6 @@
# Coding Conventions # Coding Conventions
Updated: 5/3/2016 Updated: 1/24/2018
**Table of Contents** **Table of Contents**
@ -8,8 +8,6 @@ Updated: 5/3/2016
- [Code conventions](#code-conventions) - [Code conventions](#code-conventions)
- [Testing conventions](#testing-conventions) - [Testing conventions](#testing-conventions)
- [Directory and file conventions](#directory-and-file-conventions) - [Directory and file conventions](#directory-and-file-conventions)
- [Coding advice](#coding-advice)
## Code conventions ## Code conventions
@ -27,16 +25,16 @@ Comments](https://github.com/golang/go/wiki/CodeReviewComments)
- [Effective Go](https://golang.org/doc/effective_go.html) - [Effective Go](https://golang.org/doc/effective_go.html)
- Know and avoid [Go landmines](https://gist.github.com/lavalamp/4bd23295a9f32706a48f)
- Comment your code. - Comment your code.
- [Go's commenting - [Go's commenting
conventions](http://blog.golang.org/godoc-documenting-go-code) conventions](http://blog.golang.org/godoc-documenting-go-code)
- If reviewers ask questions about why the code is the way it is, that's a - If reviewers ask questions about why the code is the way it is, that's a
sign that comments might be helpful. sign that comments might be helpful.
- Command-line flags should use dashes, not underscores - Command-line flags should use dashes, not underscores
- Naming - Naming
- Please consider package name when selecting an interface name, and avoid - Please consider package name when selecting an interface name, and avoid
redundancy. redundancy.
@ -130,9 +128,3 @@ using the system](https://kubernetes.io/docs/user-guide/config-best-practices/)
- Third-party code must include licenses - Third-party code must include licenses
- This includes modified third-party code and excerpts, as well - This includes modified third-party code and excerpts, as well
## Coding advice
- Go
- [Go landmines](https://gist.github.com/lavalamp/4bd23295a9f32706a48f)