Skip to content

Improve changelog and pull request templates - #300

Merged
youtux merged 1 commit into
masterfrom
improve-repository-templates
Oct 31, 2026
Merged

youtux merged 1 commit into
masterfrom
improve-repository-templates

Conversation

@youtux

@youtux youtux commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

🔍 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

  • I have added an entry to CHANGES.rst.
    • Waived: does not apply because this is a repository template-only change.
  • The changes are covered by tests.
    • Waived: does not apply because this is a repository template-only change.
  • I have updated the documentation where necessary.

Make the changelog category template reusable without rendering empty sections. Add a pull request template with a standard contribution checklist.
Copilot AI balanced review requested due to automatic review settings October 31, 2026 14:40
@youtux
youtux merged commit f85110a into master Oct 31, 2026
11 checks passed
@youtux
youtux deleted the improve-repository-templates branch October 31, 2026 14:41

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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

codecov Bot commented Oct 31, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.84%. Comparing base (c56b063) to head (9b54d70).
⚠️ Report is 2 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants