| 1 | # Contributing
|
| 2 |
|
| 3 | Contributions are always welcome, no matter how large or small. Before
|
| 4 | contributing, please read the
|
| 5 | [code of conduct](https://github.com/format-message/format-message/blob/master/CODE_OF_CONDUCT.md).
|
| 6 |
|
| 7 | ## Developing
|
| 8 |
|
| 9 | #### Workflow
|
| 10 |
|
| 11 | * Fork the repository
|
| 12 | * Clone your fork and change directory to it (`git clone git@github.com:yourUserName/format-message.git && cd format-message`)
|
| 13 | * Install the project dependencies (`npm install`)
|
| 14 | * Link your forked clone (`npm link`)
|
| 15 | * Develop your changes ensuring you're fetching updates from upstream often
|
| 16 | * Ensure the test are passing (`npm test`)
|
| 17 | * Create new pull request explaining your proposed change or reference an issue
|
| 18 | in your commit message
|
| 19 |
|
| 20 | #### Code Standards
|
| 21 |
|
| 22 | * Use ES 2015 syntax, except anything that requires the babel runtime.
|
| 23 | * Follow [JavaScript Standard Style](https://github.com/feross/standard).
|
| 24 |
|
| 25 | ## Testing
|
| 26 |
|
| 27 | $ npm test
|
| 28 |
|
| 29 | ## Linting
|
| 30 |
|
| 31 | $ npm run lint
|