CONTRIBUTING.md 2.07 KB
Newer Older
Samuel Bernard's avatar
Samuel Bernard committed
1
2
3
4
5
6
7
8
9
10
11
Contributing
------------

You are more than welcome to submit issues and merge requests to this project.

### Foodcritic, Rubocop and Tests

Your commits must not break any tests, foodcritic nor rubocop.

### Commits format

12
13
14
15
Your commits must pass `git log --check` and messages should be formatted
like this (read
[post](http://karma-runner.github.io/1.0/dev/git-commit-msg.html)
for details):
Samuel Bernard's avatar
Samuel Bernard committed
16
17

```
18
type(scope): subject, all in 50 characters or less
Samuel Bernard's avatar
Samuel Bernard committed
19

20
21
22
23
24
25
body: Provide more detail after the first line. Leave one blank line
below the summary and wrap all lines at 72 characters or less.

Uses the imperative, present tense: “change” not “changed” nor
"changes". Includes motivation for the change and contrasts with
previous behavior.
Samuel Bernard's avatar
Samuel Bernard committed
26
27
28
29
30
31
32
33

If the change fixes an issue, leave another blank line after the final
paragraph and indicate which issue is fixed in the specific format
below.

Fix #42
```

34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
Allowed <type> values:

- feat (new feature for the user, not a new feature for build script)
- fix (bug fix for the user, not a fix to a build script)
- docs (changes to the documentation)
- style (formatting, missing semi colons, etc; no production code change)
- refactor (refactoring production code, eg. renaming a variable)
- test (adding missing tests, refactoring tests; no production code change)
- chore (updating grunt tasks etc; no production code change)

Example <scope> values:

- recipe name (like config, install, etc.)
- rubocop, foodcritic, kitchen (when dealing with specific tool)
- etc.

The <scope> can be empty (e.g. if the change is a global or difficult to assign
to a single component), in which case the parentheses are omitted.

Samuel Bernard's avatar
Samuel Bernard committed
53
54
55
56
57
58
59
60
61
62
Also do your best to factor commits appropriately, ie not too large with
unrelated things in the same commit, and not too small with the same small
change applied N times in N different commits. If there was some accidental
reformatting or whitespace changes during the course of your commits, please
rebase them away before submitting the MR.

### Files

All files must be 80 columns width formatted (actually 79), exception only
when it is really not possible.