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

doc: update coding guideline to suggest to place local imports last

Browse Source 
It seems very common in other Go based projects to place the local
packages in the import statement last. Currently Ceph-CSI expects the
imports to group the local packages immediately after standard packages.
This exception compared to other projects often requires new
contributors to 'correct' their PR.

Following a more common convention for grouping imports should make it a
little easier to contribute to the project.

Signed-off-by: Niels de Vos <ndevos@ibm.com>
This commit is contained in:
Niels de Vos 2024-07-19 16:03:39 +02:00 committed by mergify[bot]
parent 141da9af42
commit dce8561f33
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/coding.md
View File

@ -18,14 +18,14 @@ the code and will be pointed out in the review process:
### Imports ### Imports
We use the following convention for specifying imports: We prefer the following convention for specifying imports:
``` ```
<import standard library packages> <import standard library packages>
<import ceph-csi packages>
<import third-party packages> <import third-party packages>
<import ceph-csi packages>
``` ```
Example: Example:
@ -37,9 +37,9 @@ import (
"strings" "strings"
"time" "time"
"github.com/ceph/ceph-csi/internal/util"
"github.com/pborman/uuid" "github.com/pborman/uuid"
"github.com/ceph/ceph-csi/internal/util"
) )
``` ```