Skip to content

Commit

Permalink
Add pull request template with checklist and guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
forntoh committed Oct 4, 2024
1 parent 5372bd8 commit e430eef
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
## Pull Request Checklist

### General Requirements

- [ ] I have kept this PR in draft until all the required tasks are completed.
- [ ] I have reviewed the [contributing guidelines](CONTRIBUTING.md) for this project.
- [ ] I have checked that this PR does not introduce any breaking changes unless explicitly stated.
- [ ] I have checked that changes generate no new warnings.
- [ ] I have added tests that prove my fix is effective.
- [ ] I have performed a self-review of my own code

### Bug Fix

<!-- Delete this section if it doesn't apply to your PR. -->

- [ ] This PR is a bug fix.
- [ ] I have added a link to the bug in the description.
- [ ] I have tagged this PR with `bugfix`.

### Feature

<!-- Delete this section if it doesn't apply to your PR. -->

- [ ] This PR is a new feature.
- [ ] I have included an example sketch file.
- [ ] I have commented my code thoroughly.
- [ ] I have added documentation for the new feature.
- [ ] I have generated and reviewed the documentation locally or on readthe docs.
- [ ] I have created a functionality test to validate the new feature.

## Description

<!-- Please include a summary of the change and which issue is fixed. Include any relevant motivation and context. -->

## How Has This Been Tested?

<!-- Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. -->

## Screenshots/Video (if applicable)

<!-- If applicable, add screenshots to help explain your changes. -->

## Additional Notes

<!-- Add any other relevant information about the PR here. -->

0 comments on commit e430eef

Please sign in to comment.