You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
46 lines
988 B
46 lines
988 B
# Harmony Benchmark
|
|
[](https://travis-ci.com/simple-rules/harmony-benchmark)
|
|
|
|
## Golang Coding Convention
|
|
|
|
* Follow [effective_go](https://golang.org/doc/effective_go.html)
|
|
* Constant enum should follow CamelCase.
|
|
* Comments of each element in a struct is written right after the element.
|
|
|
|
## Dev Environment Setup
|
|
|
|
|
|
```
|
|
export GOPATH=$HOME/<path_of_your_choice>
|
|
|
|
mkdir -p $HOME/<path_of_your_choice>/src
|
|
|
|
cd $HOME/<path_of_your_choice>/src
|
|
|
|
git clone git@github.com:simple-rules/harmony-benchmark.git
|
|
|
|
cd harmony-benchmark
|
|
|
|
go get github.com/go-stack/stack
|
|
```
|
|
## Usage
|
|
```
|
|
./deploy.sh local_config.txt
|
|
```
|
|
|
|
## Testing
|
|
|
|
Make sure you the following command and make sure everything passed before submitting your code.
|
|
|
|
```
|
|
./test_before_submit.sh
|
|
```
|
|
|
|
## Linting
|
|
|
|
Make sure you the following command and make sure everything passes golint.
|
|
|
|
```
|
|
./lint_before_submit.sh
|
|
```
|
|
|
|
|