matthew-matvei/freeman

View on GitHub
.github/PULL_REQUEST_TEMPLATE.md

Summary

Maintainability
Test Coverage
<!--- Provide a general summary of your changes in the Title above -->

<!-- Please do not create a Pull Request without creating an issue first.
Any change needs to be discussed before proceeding.
Failure to do so may result in the rejection of the pull request. -->

## Description

<!--- Describe your changes in detail, then fill in the checklist below -->

- [ ] I have followed the [Contributing Guidlines](CONTRIBUTING.md)
- [ ] There are no open pull requests for the same update
- [ ] My pull request targets the `develop` branch of the FreeMAN repository
- [ ] I have incremented the patch segment of the version number

## Related Issue

<!--- If suggesting a new feature or change, please discuss it in an issue first -->
<!--- If fixing a bug, there should be an issue describing it with steps to reproduce -->
<!--- Please link to the issue here. Note that there should only be one
linked issue -->
<!--- Please ensure you have marked items in any checklist in the related issue
that have been resolved by code in this pull request -->

This pull request closes #*{issue number}*

## Testing

<!--- Please describe in detail how you tested your changes -->
<!--- Include details of your testing environment, and the tests you ran -->
<!--- When done, fill in the checklist -->

- [ ] Added tests
- [ ] Ran `npm run lint` successfully
- [ ] Ran `npm run test` successfully

## Documentation

<!--- If no documentation / config changes were required, remove the checklist / section -->

- [ ] Added / updated Markdown documentation (e.g. `README.md`)
- [ ] Added / updated JSDoc documentation
- [ ] Updated example config files (e.g. `freeman.settings.json`)

## Screenshots

<!-- Include if appropriate, otherwise remove section -->