Skip to content

Commit acd8896

Browse files
committed
docs(CONTRIBUTING): add contributing guidelines
1 parent 3aa841f commit acd8896

File tree

1 file changed

+45
-0
lines changed

1 file changed

+45
-0
lines changed

CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing
2+
3+
I am open to any contributions made by you.
4+
5+
### Linting
6+
7+
Please check your code using `npm run lint` before submitting your pull requests.
8+
9+
### Commit Message Format
10+
11+
Each commit message should include a **type**, a **scope** and a **subject**:
12+
13+
```
14+
<type>(<scope>): <subject>
15+
```
16+
17+
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
18+
19+
#### Type
20+
21+
Must be one of the following:
22+
23+
* **feat**: A new feature
24+
* **fix**: A bug fix
25+
* **docs**: Documentation only changes
26+
* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
27+
semi-colons, etc)
28+
* **refactor**: A code change that neither fixes a bug or adds a feature
29+
* **perf**: A code change that improves performance
30+
* **test**: Adding missing tests
31+
* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
32+
generation
33+
34+
#### Scope
35+
36+
The scope could be anything specifying place of the commit change. For example `webpack`, `server`,
37+
`eslint`, `babel`, `reactComponentName` etc...
38+
39+
#### Subject
40+
41+
The subject contains succinct description of the change:
42+
43+
* use the imperative, present tense: "change" not "changed" nor "changes"
44+
* don't capitalize first letter
45+
* no dot (.) at the end

0 commit comments

Comments
 (0)