mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-11-09 16:00:22 +00:00
Update coding.md
Signed-off-by: Humble Chirammal <hchiramm@redhat.com>
This commit is contained in:
parent
1444231d05
commit
69c4e7537f
@ -5,7 +5,7 @@ Card](https://goreportcard.com/badge/github.com/ceph/ceph-csi)](https://goreport
|
||||
[![Build
|
||||
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,
|
||||
and attacher for Ceph RBD and CephFS.
|
||||
|
||||
|
@ -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.
|
||||
* Do not export a function or variable name outside the package until you
|
||||
have an external consumer for it.
|
||||
* Do not use named return values in function definitions. Use only the type.
|
||||
Exception: defer()'d functions.
|
||||
|
||||
### Imports
|
||||
|
||||
@ -60,8 +58,6 @@ import (
|
||||
|
||||
### 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
|
||||
be done by the caller on receiving an `error`.
|
||||
* Always use log level `DEBUG` to provide useful **diagnostic information** to
|
||||
|
Loading…
Reference in New Issue
Block a user