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.

16 lines
1015 B

  1. # Contributing to Bleve
  2. We look forward to your contributions, but ask that you first review these guidelines.
  3. ### Sign the CLA
  4. As Bleve is a Couchbase project we require contributors accept the [Couchbase Contributor License Agreement](http://review.couchbase.org/static/individual_agreement.html). To sign this agreement log into the Couchbase [code review tool](http://review.couchbase.org/). The Bleve project does not use this code review tool but it is still used to track acceptance of the contributor license agreements.
  5. ### Submitting a Pull Request
  6. All types of contributions are welcome, but please keep the following in mind:
  7. - If you're planning a large change, you should really discuss it in a github issue or on the google group first. This helps avoid duplicate effort and spending time on something that may not be merged.
  8. - Existing tests should continue to pass, new tests for the contribution are nice to have.
  9. - All code should have gone through `go fmt`
  10. - All code should pass `go vet`