Skip to content

Commit 791f992

Browse files
authored
Chore: update coding style in CONTRIBUTING.md (#256)
CONTRIBUTING.md file is updated to further clarify the coding style guideline.
1 parent 77e1f26 commit 791f992

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,24 @@ There is no strict coding style guideline, but some basic suggestions are:
4343

4444
* Try to run `go fmt ./...` and `./lint.sh`
4545
* When go packages are imported in a file, packages are grouped into three categories: go standard packages, third party packages and project's own packages.
46-
Place a new line between each group of packages.
46+
Place a new line between each group of packages. An example:
47+
48+
```go
49+
import (
50+
"crypto/tls"
51+
"encoding/json"
52+
"fmt"
53+
"net/http"
54+
"os"
55+
"time"
56+
57+
"github.com/cenkalti/backoff/v4"
58+
"go.uber.org/zap"
59+
60+
"github.com/cisco-open/flame/pkg/openapi"
61+
"github.com/cisco-open/flame/pkg/restapi"
62+
)
63+
```
4764

4865
## License
4966
By contributing, you agree that your contributions will be licensed under its Apache License, Version 2.

0 commit comments

Comments
 (0)