mirrors/ceph-csi
1
0
Fork 0
mirror of https://github.com/ceph/ceph-csi.git synced 2024-11-26 08:10:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update coding.md

Browse Source 
Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
This commit is contained in:
Humble Chirammal 2019-06-04 11:47:45 +05:30
parent 1444231d05
commit 69c4e7537f
2 changed files with 1 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -5,7 +5,7 @@ Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreport
[![Build [![Build
Status](https://travis-ci.org/ceph/ceph-csi.svg?branch=master)](https://travis-ci.org/ceph/ceph-csi) Status](https://travis-ci.org/ceph/ceph-csi.svg?branch=master)](https://travis-ci.org/ceph/ceph-csi)
This repo containes [Container Storage Interface(CSI)] This repo contains [Container Storage Interface(CSI)]
(<https://github.com/container-storage-interface/>) driver, provisioner, (<https://github.com/container-storage-interface/>) driver, provisioner,
and attacher for Ceph RBD and CephFS. and attacher for Ceph RBD and CephFS.

4
docs/coding.md
View File

@ -15,8 +15,6 @@ the code and will be pointed out in the review process:
* Keep variable names short for variables that are local to the function. * Keep variable names short for variables that are local to the function.
* Do not export a function or variable name outside the package until you * Do not export a function or variable name outside the package until you
have an external consumer for it. have an external consumer for it.
* Do not use named return values in function definitions. Use only the type.
Exception: defer()'d functions.
### Imports ### Imports
@ -60,8 +58,6 @@ import (
### Logging ### Logging
* If a function is only invoked as part of a transaction step, always use the
transaction's logger to ensure propagation of request ID and transaction ID.
* The inner-most utility functions should never log. Logging must almost always * The inner-most utility functions should never log. Logging must almost always
be done by the caller on receiving an `error`. be done by the caller on receiving an `error`.
* Always use log level `DEBUG` to provide useful **diagnostic information** to * Always use log level `DEBUG` to provide useful **diagnostic information** to