# Contributing Guide

* [Style Guide](#style-guide)
* [Build](#build)
* [Features Requested](#features-requested)

## Style Guide
### Code format
Lux uses [gofmt](https://golang.org/cmd/gofmt) to format the code, you must use [gofmt](https://golang.org/cmd/gofmt) to format your code before submitting.

### linter
We recommend using [golint](https://github.com/golang/lint) or [gometalinter](https://github.com/alecthomas/gometalinter) to check your code format.

## Build

Make sure that this folder is in `GOPATH`, then:

```bash
$ go build
```

## Features Requested
There are several [features](https://github.com/iawia002/lux/issues?q=is%3Aissue+is%3Aopen+label%3Afeature-request) requested by the community. If you have any idea, feel free to fork the repo, follow the style guide above, push and merge it after passing the test. Besides, you are welcomed to propose new features through the issue.
