pingcap / pingcap/tidb

Improve the release note guidance in the pull request template

Open Beginner friendly
#70,831 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
40.5k
Forks
6.2k
PR merge metrics
PR metrics pending

Description

## Enhancement

Improve the pull request template by adding a checkbox that lets PR authors indicate whether a change needs to be included in the user-facing release notes.

This change has three benefits:

1. It makes the decision simple and low-effort for PR authors: select the checkbox when a release note is needed, or leave it unselected when it is not.
2. It provides a clearer signal for both human reviewers and AI to distinguish PRs that need release notes from those that do not.
3. It recommends that PR authors write the release note themselves. If an author marks the PR as requiring a release note but leaves the release note as `None`, a bot can generate a draft later when the release notes file is prepared.

Contributor guide

Open the contributing guide

Research direction

Locate the repository's pull request template and read its existing release-note guidance first. Add the requested checkbox and recommendation for authors to provide the release note, including the stated None case; done means the template clearly distinguishes PRs that need user-facing release notes from those that do not.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
developer-experience, release
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
74/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.