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.
51 lines
1.4 KiB
51 lines
1.4 KiB
# Harmony Benchmark
|
|
[](https://travis-ci.com/harmony-one/harmony)
|
|
<a href='https://github.com/jpoles1/gopherbadger' target='_blank'></a>
|
|
|
|
|
|
## Coding Guidelines
|
|
|
|
* In general, we follow [effective_go](https://golang.org/doc/effective_go.html)
|
|
* Code must adhere to the official [Go formatting guidelines](https://golang.org/doc/effective_go.html#formatting) (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)).
|
|
* Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines.
|
|
|
|
|
|
## Dev Environment Setup
|
|
|
|
```
|
|
export GOPATH=$HOME/<path_of_your_choice>
|
|
|
|
mkdir -p $HOME/<path_of_your_choice>/src/github.com/harmony-one
|
|
|
|
cd $HOME/<path_of_your_choice>/src/github.com/harmony-one
|
|
|
|
git clone git@github.com:harmony-one/harmony.git
|
|
|
|
cd harmony
|
|
|
|
go get ./...
|
|
```
|
|
|
|
## Usage
|
|
|
|
### Running local test
|
|
```
|
|
./test/deploy.sh ./test/configs/local_config1.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
|
|
```
|
|
|
|
|