Skip to content

Commit

Permalink
Simplify the PR Template (#257)
Browse files Browse the repository at this point in the history
We haven't been filling out the PR template - this updates it to be a
smaller set of questions that we can more reliably handle.
  • Loading branch information
schreiaj authored Sep 30, 2024
1 parent b4dc71c commit e8eec70
Showing 1 changed file with 6 additions and 19 deletions.
25 changes: 6 additions & 19 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,15 @@
# Pull Request

## Description
[Provide a brief description of the changes implemented in this pull request.]

## Screenshots (if applicable)

## Related Issues
[Link any related issues or tasks from your project management system.]

## Additional Notes
[Add any additional context or notes that reviewers should know about.]

## Checklist
Please review and complete the following checklist before submitting your pull request:

- [ ] I have ensured that the pull request is of a manageable size, allowing it to be reviewed within a single session.
- [ ] I have reviewed my changes to ensure they are clear, concise, and well-documented.
- [ ] I have updated the documentation, if applicable.
- [ ] I have added or updated test cases to cover my changes, if applicable.
- [ ] I have minimized the number of reviewers to include only those essential for the review.
- [ ] I have notified teammates in the review thread to build awareness.
- [ ] The title of this PR is descriptive and concise.
- [ ] My changes follow the style guidelines of this project.
- [ ] I have added or updated test cases to cover my changes.
- [ ] I've let the team know about this PR by linking it in the review channel

## Checklist for Reviewers
Please review and complete the following checklist during the review process:

- [ ] The code follows best practices and conventions.
- [ ] The changes implement the desired functionality or fix the reported issue.
- [ ] The tests cover the new changes and pass successfully.
- [ ] Any potential edge cases or error scenarios have been considered.

0 comments on commit e8eec70

Please sign in to comment.