kolatz/umbr_api

View on GitHub
.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

Summary

Maintainability
Test Coverage
# Pull Request Template

Thank you for your contribution to this repo. Before submitting this PR,
please review and edit all necessary parts of this template:

## Description

Please include a summary of proposing changes and which issue is fixed or
features are added. Please also include relevant motivation and context.
List any dependencies that are required for this change.

## Related Issue

This project only accepts pull requests related to open issues. 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 list all
related issues.

## Type of change

Please delete options that are not relevant.

- [ ] 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 not work as expected)
- [ ] This change requires a documentation update

## How Has This Been Tested

Please describe the tests that you ran to verify your changes. Provide
instructions so we can reproduce. Please also list any relevant details
for your test configuration.

- [ ] Test A
- [ ] Test B

**Test Configuration**:

- OS version
- Umbrella subscription type
- Python and modules versions

## Checklist

- [ ] I am fully conforming with Code of Conduct
- [ ] I am running the latest version from `master` branch
- [ ] I checked the documentation and found no answer
- [ ] I checked to make sure that this issue has not already been filed by somebody else
- [ ] I opened an issue to discuss and describe issues/features
- [ ] I performed a self-review of my own code
- [ ] My code follows the style guidelines of this project
- [ ] I commented my code, particularly in hard-to-understand areas
- [ ] I made corresponding changes to the the tests that prove my fix is effective or that my features work
- [ ] I made corresponding changes to the documentation
- [ ] I ran all linters checks and they generate no new warnings/errors
- [ ] New and existing unit tests pass locally with my changes and generate no new warnings/errors
- [ ] Any dependent changes have been merged and published in downstream modules