| 1 | # Contributing
|
| 2 |
|
| 3 | Firstly, thanks for taking the time to contribute.
|
| 4 |
|
| 5 | The following is a set of guidelines for contributing to `ts-protoc-gen`.
|
| 6 |
|
| 7 | ## Pull Request Process
|
| 8 | 1. Implement your changes. If you're unsure how or would like clarification, please raise an [issue](https://github.com/improbable-eng/ts-protoc-gen/issues/new).
|
| 9 | 2. Ensure your change has sufficient test coverage.
|
| 10 | 3. Ensure all changes pass the lint check.
|
| 11 | 2. Maintainers will look to review the PR as soon as possible. If there is no traction for some time, you're welcome to bump the thread.
|
| 12 | 3. All PRs require at least one reviewer.
|
| 13 |
|
| 14 | ## Code of Conduct
|
| 15 | Please review and follow our [Code of Conduct](https://github.com/improbable-eng/ts-protoc-gen/blob/master/CODE_OF_CONDUCT.md).
|
| 16 |
|
| 17 | ## Releasing
|
| 18 | Your changes will be released with the next version release.
|
| 19 |
|
| 20 | ## Debugging
|
| 21 | You can attach the Chrome Inspector when running the tests by setting the `MOCHA_DEBUG` environment variable before running the tests, ie:
|
| 22 |
|
| 23 | ```
|
| 24 | MOCHA_DEBUG=true npm test
|
| 25 | ```
|