https://github.com/couchbaselabs/cbft

*THIS PROJECT HAS MOVED* from couchbaselabs TO: https://github.com/couchbase/cbft -- no further development will be done here on couchbaselabs/cbft
https://github.com/couchbaselabs/cbft

Last synced: 1 day ago
JSON representation

*THIS PROJECT HAS MOVED* from couchbaselabs TO: https://github.com/couchbase/cbft -- no further development will be done here on couchbaselabs/cbft

• Host: GitHub
• URL: https://github.com/couchbaselabs/cbft
• Owner: couchbaselabs
• License: other
• Created: 2014-10-13T16:22:26.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-04-07T01:30:11.000Z (over 8 years ago)
• Last Synced: 2024-06-19T00:40:48.067Z (6 months ago)
• Language: Go
• Homepage:
• Size: 5.12 MB
• Stars: 27
• Watchers: 52
• Forks: 5
• Open Issues: 57
• Metadata Files:
  • Readme: README-dev.md
  • Changelog: CHANGES.md
  • License: LICENSE-thirdparty.txt

Awesome Lists containing this project

README

        
# For cbft developers

## Dev environment setup

    go get -u github.com/couchbaselabs/cbft/...

    cd $GOPATH/src/github.com/couchbaselabs/cbft

    make prereqs

## Building cbft

    make

## Unit tests

    make test

## Coverage reports

To get local coverage reports with heatmaps...

    make coverage

To get more coverage reports that include dependencies like the bleve library...

    go test -coverpkg github.com/couchbaselabs/cbft,github.com/blevesearch/bleve,github.com/blevesearch/bleve/index \

        -coverprofile=coverage.out \

        -covermode=count && \

    go tool cover -html=coverage.out

## Documentation

Generating documentation...

We use the [MkDocs](http://mkdocs.org) tool to help generate an HTML

docs website from the markdown files in the ```./docs``` subdirectory.

To generate the REST API markdown documentation...

    make gen-docs

For a local development testing web server that automatically

re-generates the HTML website of ```./docs``` changes, run...

    mkdocs serve

Then browse to http://127.0.0.1:8000 to see the HTML docs website.

To deploy the HTML docs website to github's gh-pages, run...

    mkdocs gh-deploy

## Coding conventions

You must pass ```go fmt```.

Error message conventions...

In the cbft project, fmt.Errorf() and log.Printf() messages follow a

rough formatting convention, like...

    : , : , : 

The "short static msg string" should be unique enough so that ```git grep```

works well.

## Contributing fixes/improvements

We require a contributor license agreement (CLA) to be signed before

we can merge any pull requests.  To sign this agreement, please

register at the [couchbase code review

site](http://review.couchbase.org/). The cbft project currently does

not use this code review app, but it is still used to track acceptance

of the CLA.

All types of contributions are welcome, but please keep the following

in mind:

Existing tests should continue to pass ("make test"), and new tests

for contributions are quite nice to have.

All code should have pass "go fmt ./..." and "go vet ./...".

## Releasing

To do a full release with a new (semver) tag, see the Makefile's

"release" target.