File: CONTRIBUTING.md

package info (click to toggle)
ruby-cliver 0.3.2-3
  • links: PTS, VCS
  • area: main
  • in suites: bullseye, buster, sid, stretch
  • size: 204 kB
  • ctags: 58
  • sloc: ruby: 760; makefile: 3
file content (35 lines) | stat: -rw-r--r-- 1,342 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
# Contributing

`Cliver` is [MIT-liennsed](LICENSE.txt) and intends to follow the
[pull-request-hack][].

## Git-Flow

`Cliver` follows the [git-flow][] branching model, which means that every
commit on `master` is a release. The default working branch is `develop`, so
in general please keep feature pull-requests based against the current
`develop`.

 - fork cliver
 - use the git-flow model to start your feature or hotfix
 - make some commits (please include specs)
 - submit a pull-request

## Bug Reporting

Please include clear steps-to-reproduce. Spec files are especially welcome;
a failing spec can be contributed as a pull-request against `develop`.

## Ruby Appraiser

`Cliver` uses the [ruby-appraiser][] gem via [pre-commit][] hook, which can be
activated by installing [icefox/git-hooks][] and running `git-hooks --install`.
Reek and Rubocop are strong guidelines; use them to reduce defects as much as
you can, but if you believe clarity will be sacrificed they can be bypassed
with the `--no-verify` flag.

[git-flow]: http://nvie.com/posts/a-successful-git-branching-model/
[pre-commit]: .githooks/pre-commit/ruby-appraiser
[ruby-appraiser]: https://github.com/simplymeasured/ruby-appraiser
[icefox/git-hooks]: https://github.com/icefox/git-hooks
[pull-request-hack]: http://felixge.de/2013/03/11/the-pull-request-hack.html