Skip to content
This repository was archived by the owner on Sep 11, 2018. It is now read-only.

Commit ef05aa4

Browse files
justingreenbergDavid Zukowski
authored and
David Zukowski
committedDec 14, 2015
feat(project): add contributing guidelines
1 parent 3802426 commit ef05aa4

File tree

1 file changed

+59
-0
lines changed

1 file changed

+59
-0
lines changed
 

‎CONTRIBUTING.md

+59
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
# Contributing Guidelines
2+
3+
Some basic conventions for contributing to this project.
4+
5+
### General
6+
7+
Please make sure that there aren't existing pull requests attempting to address the issue mentioned. Likewise, please check for issues related to update, as someone else may be working on the issue in a branch or fork.
8+
9+
* Non-trivial changes should be discussed in an issue first
10+
* Develop in a topic branch, not master
11+
* Squash your commits
12+
13+
### Linting
14+
15+
Please check your code using `npm run lint` before submitting your pull requests, as the CI build will fail if `eslint` fails.
16+
17+
### Commit Message Format
18+
19+
Each commit message should include a **type**, a **scope** and a **subject**:
20+
21+
```
22+
<type>(<scope>): <subject>
23+
```
24+
25+
Lines should not exceed 100 characters. This allows the message to be easier to read on github as well as in various git tools and produces a nice, neat commit log ie:
26+
27+
```
28+
#271 feat(standard): add style config and refactor to match
29+
#270 fix(config): only override publicPath when served by webpack
30+
#269 feat(eslint-config-defaults): replace eslint-config-airbnb
31+
#268 feat(config): allow user to configure webpack stats output
32+
```
33+
34+
#### Type
35+
36+
Must be one of the following:
37+
38+
* **feat**: A new feature
39+
* **fix**: A bug fix
40+
* **docs**: Documentation only changes
41+
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
42+
semi-colons, etc)
43+
* **refactor**: A code change that neither fixes a bug or adds a feature
44+
* **test**: Adding missing tests
45+
* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
46+
generation
47+
48+
#### Scope
49+
50+
The scope could be anything specifying place of the commit change. For example `webpack`,
51+
`babel`, `redux` etc...
52+
53+
#### Subject
54+
55+
The subject contains succinct description of the change:
56+
57+
* use the imperative, present tense: "change" not "changed" nor "changes"
58+
* don't capitalize first letter
59+
* no dot (.) at the end

0 commit comments

Comments
 (0)