Skip to content

Commit 64b4198

Browse files
committed
Add contributing file
1 parent 7de2a90 commit 64b4198

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Contributing
2+
3+
:raised_hands::tada: First off, thanks for taking the time to contribute! :tada::raised_hands:
4+
5+
The following is a set of guidelines for contributing to react-datetime. The purpose of these guidelines is to maintain a high quality of code *and* traceability. Please respect these guidelines.
6+
7+
## General
8+
This repository use tests and a linter as automatic tools to maintain the quality of the code. These two tasks are run locally on your machine before every commit (as a pre-commit git hook), if any test fail or the linter gives an error you cannot create the commit. They are also run on a Travis CI machine when you create a pull request, and will not be merged unless Travis says all tests and the linting pass.
9+
10+
## Git Commit Messages
11+
* Use the present tense ("Add feature" not "Added feature")
12+
* Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
13+
* Think of it as you are *commanding* what your commit is doing
14+
* Git itself uses the imperative whenever it creates a commit on your behalf, so it makes sense for you to use it too!
15+
* Use the body to explain *what* and *why*
16+
* If the commit is non-trivial, please provide more detailed information in the commit body message
17+
* *How* you made the change is visible in the code and is therefore very rarely necessary to include in the commit body message, but *why* you made the change is often harder to guess and should therefore be included in the commit body message
18+
19+
[Here's a nice blog post](http://chris.beams.io/posts/git-commit/) about how to write great git messages - it's worth a read.
20+
21+
## Pull Requests
22+
* Follow the current code style
23+
* Write tests for your changes
24+
* Add to documentation if it is needed
25+
* End files with a newline
26+

0 commit comments

Comments
 (0)