djbrown/hbscorez

View on GitHub
.github/PULL_REQUEST_TEMPLATE.md

Summary

Maintainability
Test Coverage
# Change Types

<!--- What types of changes does your code introduce? Put an `x` in all the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

<!--- Provide a general summary of your changes in the Title above -->
# Description
<!--- Describe your changes -->
<!--- Why is this change required? What problem does it solve? -->
<!--- If it fixes open issues, please link to the issues -->

- *Feature 1* I was always frustrated when...
  - what was missing before?
  - what is better now?
  - what does not work anymore?
- *Bugfix 1*
  - what did not work before?
  - what happens now instead?
  - *Steps to reproduce*
    1. go to '...'
    1. click on '....'
    1. scroll down to '....'
    1. see error / incorrect result '...'

# Optional

- alternatives you've considered
- relevant screenshots
- version used (e.g. website, local copy at commit X)
- browser (e.g. Chrome 68, Firefox 61, Safari 11):
- OS (e.g. Windows 10, Ubuntu 18.04, Android 8.0, iOS 11.4.1):

# Checklist

<!--- Go over all the following points, and put an `x` in all the boxes that apply. -->
<!--- If you're unsure about any of these, don't hesitate to ask. We're here to help! -->

- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [ ] I have read [CONTRIBUTING.md](https://github.com/djbrown/hbscorez/blob/master/.github/CONTRIBUTING.md).
- [ ] I have added tests to cover my changes.
- [ ] My tests run automatically.
- [ ] All new and existing tests passed.