| 1 | # Contributing
|
| 2 |
|
| 3 | ## Reporting Issues
|
| 4 |
|
| 5 | If you have found a bug in `doxdox` please consider the following when submitting an issue:
|
| 6 |
|
| 7 | - **Search existing [GitHub Issues](https://github.com/neogeek/doxdox/issues)** - The bug you are experiencing might have already been reported or even fixed in an unreleased version of `doxdox` so be sure to review both [open](https://github.com/neogeek/doxdox/issues?state=open) and [closed](https://github.com/neogeek/doxdox/issues?state=closed) issues.
|
| 8 | - **Create a reproducible test case** - To make it easier for maintainers to validate the issue please include a [gist](https://gist.github.com/) containing files used to reproduce the issue.
|
| 9 | - **Include relevant information** - Include clear steps to reproduce the issue.
|
| 10 |
|
| 11 | ## Pull Requests
|
| 12 |
|
| 13 | Before submitting a pull request, be sure that the following requirements are meet:
|
| 14 |
|
| 15 | - Additional tests have been added to validate the changes.
|
| 16 | - Relevant documentation has been added.
|
| 17 | - The build passes.
|
| 18 | - There are no `eslint` errors using the included `.eslintrc` configuration.
|
| 19 |
|
| 20 | ## Code Style
|
| 21 |
|
| 22 | - Use semicolons.
|
| 23 | - Soft indent with 4 spaces.
|
| 24 | - Always use camelCase.
|
| 25 | - Prefer `'` over `"`.
|
| 26 | - `'use strict';`
|
| 27 | - Prefer strict equals `===` unless type coercion is needed.
|
| 28 | - No trailing whitespace.
|
| 29 | - Maintain newline at EOF.
|
| 30 |
|
| 31 | ## License
|
| 32 |
|
| 33 | By contributing to `doxdox` you agree that your contributions fall under the same license, [The MIT License (MIT)](LICENSE).
|