| 1 | # Contributing
|
| 2 |
|
| 3 | ## Creating your changes
|
| 4 |
|
| 5 | 1. Fork, then clone the repo:
|
| 6 |
|
| 7 | `git clone git@github.com:your-username/barrelsby.git`
|
| 8 |
|
| 9 | 2. Install dependencies:
|
| 10 |
|
| 11 | `npm install`
|
| 12 |
|
| 13 | 3. Make your changes.
|
| 14 |
|
| 15 | 4. Make sure the tests pass:
|
| 16 |
|
| 17 | `npm test`
|
| 18 |
|
| 19 | 5. Push to your fork and [submit a pull request][pullrequest].
|
| 20 |
|
| 21 | [pullrequest]: https://github.com/bencoveney/barrelsby/compare/
|
| 22 |
|
| 23 | If you are developing on windows you may need to convert line endings to unix-style. You can do
|
| 24 | this in git bash by running `find . -type f -exec dos2unix {} \;`.
|
| 25 |
|
| 26 | ## Requirements
|
| 27 |
|
| 28 | If you are interested in contributing to barrelsby there are plenty of tagged issues that can be
|
| 29 | picked up, or feel free to suggest your own feature in an issue.
|
| 30 |
|
| 31 | Most coding conventions are enforced by TSLint but in general:
|
| 32 | - Use small functions instead of classes.
|
| 33 | - Avoid abreviated identifiers.
|
| 34 | - Write a unit test (`fileName.test.ts`) for code changes.
|
| 35 | - Write an integration test (`test/feature/`) for option changes.
|