Skip to content
This repository has been archived by the owner on May 22, 2020. It is now read-only.

Add contributing guide #63

Merged
merged 1 commit into from
Oct 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
## Contributing to Bucket

Bucket specialized framework for one-bucket usage of Couchbase. Our aim to provide simple usage of Couchbase over best practices like:

- Handle bucket as SQL's database
- No embedded fields over the JSON, only simple ones per document (this makes indexing lot more efficient)
- Full-text search capabilities
- Automatic document indexing based on tagged structs

#### Contributing

We are following the `git flow` principles.

- New changes comes as feature branches. Branch name looks like ex.: `feature/T52-short-name` where the T{num} represents the issue number
- We ONLY accepts pull requests into our develop branch.
- The most up-to-date branch is the develop, so new features should created from it.
- Releases happens frequently from develop to master with semantic versions.

#### Development environment.

Since it's a framework for Couchbase it's required to run a Couchbase. We can provide the necessary infrastructure by the following command. (NOTE: after the start it will setup a cluster and a bucket, so before running the tests it's necessary to wait a bit)

- `make dev`


6 changes: 5 additions & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
testing:
PKG_TEST=testing go test ./...
PKG_TEST=testing go test ./...

dev:
docker-compose -f test/docker-compose.yml down
docker-compose -f test/docker-compose.yml up -d