forked from thrasher-corp/gocryptotrader
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
Coding Style | ||
=============== | ||
|
||
In order to maintain a consistent style across the codebase, the following coding style has been adopted: | ||
|
||
- Function names use PascalCase (func SomeFunc()). | ||
- Function names using acronyms are capitilised (func SendHTTPRequest()). | ||
- Variable names use CamelCase (var someVar()). | ||
- Coding style uses gofmt. | ||
- Const variables are capitilised. | ||
- In line with gofmt, for loops and if statements don't require paranthesis. | ||
|
||
Block style example: | ||
```go | ||
func SendHTTPRequest(method, path string, headers map[string]string, body io.Reader) (string, error) { | ||
result := strings.ToUpper(method) | ||
|
||
if result != "POST" && result != "GET" && result != "DELETE" { | ||
return "", errors.New("Invalid HTTP method specified.") | ||
} | ||
|
||
req, err := http.NewRequest(method, path, body) | ||
|
||
if err != nil { | ||
return "", err | ||
} | ||
|
||
for k, v := range headers { | ||
req.Header.Add(k, v) | ||
} | ||
... | ||
} | ||
``` |