umgeher/leveled
0
Fork 0
Code Issues Pull requests Releases Activity Actions

Merge pull request #151 from russelldb/rdb/contributing

Browse source 
Add instructions for contributing/running tests
This commit is contained in:
Martin Sumner 2018-07-24 12:14:26 +01:00 • committed by GitHub
commit bb4a54eb5d
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -126,3 +126,15 @@ Building this from source as part of Riak will require a bit of fiddling around.
- remember to set the storage backend to leveled in riak.conf
To help with the breakdown of cuttlefish, leveled parameters can be set via riak_kv/include/riak_kv_leveled.hrl - although a new make will be required for these changes to take effect.
### Contributing
In order to contribute to leveled, fork the repository, make a branch
for your changes, and open a pull request. The acceptance criteria for
updating leveled is that it passes rebar3 dialyzer, xref, eunit, and
ct with 100% coverage.
To have rebar3 execute the full set of tests, run:
rebar3 as test do cover --reset, eunit --cover, ct --cover, cover --verbose