mirror of
https://github.com/crawlab-team/crawlab.git
synced 2026-01-24 17:41:03 +01:00
15 lines
801 B
Markdown
15 lines
801 B
Markdown
Contributing
|
|
-------------------------
|
|
|
|
We really appreciate contributions, but they must meet the following requirements:
|
|
|
|
* A PR should have a brief description of the problem/feature being proposed
|
|
* Pull requests should target the `development` branch
|
|
* Existing tests should pass and any new code should be covered with it's own test(s) (use [travis-ci](https://travis-ci.org))
|
|
* New functions should be [documented](https://blog.golang.org/godoc-documenting-go-code) clearly
|
|
* Code should pass `golint`, `go vet` and `go fmt`
|
|
|
|
We merge PRs into `development`, which is then tested in a sharded, replicated environment in our datacenter for regressions. Once everyone is happy, we merge to master - this is to maintain a bit of quality control past the usual PR process.
|
|
|
|
**Thanks** for helping!
|