diff options
| author | Tim Pepper <tpepper@vmware.com> | 2018-01-24 13:48:23 -0800 |
|---|---|---|
| committer | Tim Pepper <tpepper@vmware.com> | 2018-01-25 17:29:22 -0800 |
| commit | 482b91feef0241bf185abb9ca33a8da55f465338 (patch) | |
| tree | aac650cdb7c94019cb61412a323729b0577383e3 | |
| parent | 292926e324b35748e3d46cacb02a020827bc353d (diff) | |
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>
| -rw-r--r-- | contributors/devel/coding-conventions.md | 14 |
1 files changed, 3 insertions, 11 deletions
diff --git a/contributors/devel/coding-conventions.md b/contributors/devel/coding-conventions.md index 17c890a9..88a6a654 100644 --- a/contributors/devel/coding-conventions.md +++ b/contributors/devel/coding-conventions.md @@ -1,6 +1,6 @@ # Coding Conventions -Updated: 5/3/2016 +Updated: 1/24/2018 **Table of Contents** @@ -8,8 +8,6 @@ Updated: 5/3/2016 - [Code conventions](#code-conventions) - [Testing conventions](#testing-conventions) - [Directory and file conventions](#directory-and-file-conventions) - - [Coding advice](#coding-advice) - ## Code conventions @@ -27,16 +25,16 @@ Comments](https://github.com/golang/go/wiki/CodeReviewComments) - [Effective Go](https://golang.org/doc/effective_go.html) + - Know and avoid [Go landmines](https://gist.github.com/lavalamp/4bd23295a9f32706a48f) + - Comment your code. - [Go's commenting 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 sign that comments might be helpful. - - Command-line flags should use dashes, not underscores - - Naming - Please consider package name when selecting an interface name, and avoid redundancy. @@ -130,9 +128,3 @@ using the system](https://kubernetes.io/docs/user-guide/config-best-practices/) - Third-party code must include licenses - This includes modified third-party code and excerpts, as well - -## Coding advice - - - Go - - - [Go landmines](https://gist.github.com/lavalamp/4bd23295a9f32706a48f) |