Skip to content

Commit 8a327e4

Browse files
authored
Merge pull request globalsign#22 from globalsign/feature/contribution-guidelines
Add contribution guidelines
2 parents 13c211b + 0cf5bab commit 8a327e4

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

CONTRIBUTING.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
Contributing
2+
-------------------------
3+
4+
We really appreciate contributions, but they must meet the following requirements:
5+
6+
* A PR should have a brief description of the problem/feature being proposed
7+
* Pull requests should target the `development` branch
8+
* Existing tests should pass and any new code should be covered with it's own test(s) (use [travis-ci](https://travis-ci.org))
9+
* New functions should be [documented](https://blog.golang.org/godoc-documenting-go-code) clearly
10+
* Code should pass `golint`, `go vet` and `go fmt`
11+
12+
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.
13+
14+
**Thanks** for helping!

0 commit comments

Comments
 (0)