Skip to content

Commit

Permalink
Add a Pull Request template (#18)
Browse files Browse the repository at this point in the history
* style: Update minimum version of pylint to match the settings used by the project.

* ci: Added a pull request template for GitHub pull requests.
  • Loading branch information
nfelt14 authored Oct 4, 2023
1 parent 227972f commit e65c5ba
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 1 deletion.
30 changes: 30 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Proposed changes

Please include a summary of the changes and any links to related issues. Please also include relevant motivation and context.

## Types of changes

What types of changes does your code introduce?
_Put an `x` in the boxes that apply_

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Functionality update (non-breaking change which updates or changes existing functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update (if none of the other choices apply)

## Checklist

_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._

- [ ] I have followed the guidelines in the [CONTRIBUTING](https://github.com/tektronix/tm_devices/blob/main/CONTRIBUTING.md) document
- [ ] I have signed the CLA
- [ ] I have checked to ensure there aren't other open [Pull Requests](https://github.com/tektronix/tm_devices/pulls) for the same update/change
- [ ] I have performed a self-review of my code
- [ ] My code follows the style guidelines of this project
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] Basic linting passes locally with my changes
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] I have added necessary documentation (if appropriate)
- [ ] I have updated the Changelog with a brief description of my changes
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ myst-parser = ">=0.19.1"
pip = ">=22.0"
poetry = ">=1.5.1"
pre-commit = ">=2.20.0"
pylint = {extras = ["spelling"], version = ">=2.17.2"}
pylint = {extras = ["spelling"], version = ">=3.0"}
pyright = ">=1.1.329"
pyroma = ">=4.2"
pytest = ">=7.1.2"
Expand Down

0 comments on commit e65c5ba

Please sign in to comment.