Skip to content

Commit

Permalink
simplify the pr template (#411)
Browse files Browse the repository at this point in the history
### Description

Template had too many sections which were never use. keep it simple.
keep it clean. keep it useful

<!-- start pr-codex -->

---

## PR-Codex overview
This PR updates the pull request template in the
`.github/pull_request_template.md` file to enhance clarity and
structure, particularly in the explanation of changes and their
implications.

### Detailed summary
- Changed the prompt from "A few sentences describing the overall
effects and goals..." to "Tell us why these changes are being made".
- Updated section header from "### Other changes" to "#### Other
changes".
- Added a note to delete the "Other changes" section if none exist.
- Removed the "### Backwards compatibility" and "### Documentation"
sections from the template.

> ✨ Ask PR-Codex anything about this PR by commenting with `/codex {your
question}`

<!-- end pr-codex -->
  • Loading branch information
aaronmgdr authored Oct 30, 2024
1 parent 3890220 commit b56b69d
Showing 1 changed file with 3 additions and 12 deletions.
15 changes: 3 additions & 12 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
### Description

_A few sentences describing the overall effects and goals of the pull request's commits.
What is the current behavior, and what is the updated/expected behavior with this PR?_
_Tell us why these changes are being made_

### Other changes
#### Other changes

_Describe any minor or "drive-by" changes here._
_Describe any minor or "drive-by" changes here. If none delete this section_

### Tested

Expand All @@ -14,11 +13,3 @@ _An explanation of how the changes were tested or an explanation as to why they
### Related issues

- Fixes #[issue number here]

### Backwards compatibility

_Brief explanation of why these changes are/are not backwards compatible._

### Documentation

_The set of community facing docs that have been added/modified because of this change_

0 comments on commit b56b69d

Please sign in to comment.