-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Closes #27
- Loading branch information
Showing
1 changed file
with
31 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,31 @@ | ||
##Contributing## | ||
###Pull Requests### | ||
After forking the repository please create a pull request before creating the fix. This way we can talk about how the fix will be implemeted. This will greatly increase your chance of your patch getting merged into the code base. | ||
# Contributing | ||
|
||
## Pull Requests | ||
|
||
After forking the repository please create a pull request before creating the fix. This way we can talk about how the | ||
fix will be implemented. This will greatly increase your chance of your patch getting merged into the code base. | ||
|
||
## Commit Template | ||
|
||
Please run the following to make sure you commit messages conform to the project | ||
standards. | ||
|
||
```bash | ||
git config --local commit.template .gitmessage | ||
``` | ||
|
||
## Markdown | ||
|
||
There are linting rules for the markdown documentation in this project. So | ||
please adhere to them. This can be achieved by installing the node module | ||
`markdownlint-cli`. | ||
|
||
```bash | ||
npm install -g markdownlint-cli | ||
``` | ||
|
||
Then to check your Markdown run. | ||
|
||
```bash | ||
markdownlint . | ||
``` |