Repository navigation
Improve changelog and pull request templates - #300
Merged
Merged
Conversation
Make the changelog category template reusable without rendering empty sections. Add a pull request template with a standard contribution checklist.
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues are recorded for the changelog cleanup and pull request template updates.
No open issues 🎉
What changed in this PR
Improves changelog presentation and standardizes the context contributors provide when opening pull requests.
Changes:
- Places a reusable changelog category template inside an RST comment so it does not render.
- Removes empty category headings from previous release notes.
- Adds a pull request template with problem and change summaries, plus a contribution checklist with waiver guidance.
| File | Description |
|---|---|
CHANGES.rst |
Adds a commented release template and removes empty historical categories. |
.github/PULL_REQUEST_TEMPLATE.md |
Prompts contributors for context and changelog, testing, and documentation checks. |
Review effort: Balanced
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #300 +/- ##
=======================================
Coverage 97.84% 97.84%
=======================================
Files 17 17
Lines 927 927
Branches 55 55
=======================================
Hits 907 907
Misses 9 9
Partials 11 11 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🔍 Problem statement
The changelog category template renders as an empty release section, and contributors do not have a pull request template prompting them to provide useful context and complete routine checks.
🛠️ What's changed
Move the changelog category template into an RST comment and remove empty category headings from previous release notes. Add a pull request template with sections for the problem statement and changes, plus a contribution checklist.
✅ Checklist
CHANGES.rst.