Skip to content

Add guidance comments to PR template encouraging compact descriptions#18737

Merged
harupy merged 3 commits intomasterfrom
copilot/update-pull-request-template
Nov 7, 2025
Merged

Add guidance comments to PR template encouraging compact descriptions#18737
harupy merged 3 commits intomasterfrom
copilot/update-pull-request-template

Conversation

Copy link
Contributor

Copilot AI commented Nov 7, 2025

Related Issues/PRs

#xxx

What changes are proposed in this pull request?

Added HTML comments to .github/pull_request_template.md to guide contributors:

  • Added a comment at the top instructing contributors to remove unused checkboxes except for the patch release section
  • Updated the patch release section comment to explicitly state that both checkboxes should be kept

These changes encourage cleaner, more focused PR descriptions while ensuring the critical patch release checkboxes are always preserved.

How is this PR tested?

  • Manual tests

Verified the comments appear correctly in the template file and existing GitHub workflow checks (DCO validation, release note label validation) continue to function.

Does this PR require documentation update?

  • No. You can skip the rest of this section.

Release Notes

Is this a user-facing change?

  • No. You can skip the rest of this section.

What component(s), interfaces, languages, and integrations does this PR affect?

Components

  • area/docs: MLflow documentation pages

How should the PR be classified in the release notes? Choose one:

  • rn/none - No description will be included. The PR will be mentioned only by the PR number in the "Small Bugfixes and Documentation Updates" section

Should this PR be included in the next patch release?

Yes should be selected for bug fixes, documentation updates, and other small changes. No should be selected for new features and larger changes. If you're unsure about the release classification of this PR, leave this unchecked to let the maintainers decide.

What is a minor/patch release?
  • Minor release: a release that increments the second part of the version number (e.g., 1.2.0 -> 1.3.0).
    Bug fixes, doc updates and new features usually go into minor releases.
  • Patch release: a release that increments the third part of the version number (e.g., 1.2.0 -> 1.2.1).
    Bug fixes and doc updates usually go into patch releases.
  • Yes (this PR will be cherry-picked and included in the next patch release)
  • No (this PR will be included in the next minor release)
Original prompt

Insert the following comment at the top of .github/pull_request_template.md to encourage contributors/maintainers to remove unused checkboxes and keep the PR description compact

<!-- Remove unused checkboxes except for the patch release section at the bottom -->

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@harupy harupy marked this pull request as ready for review November 7, 2025 13:31
@harupy harupy added the rn/none List under Small Changes in Changelogs. label Nov 7, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Nov 7, 2025

@Copilot Thank you for the contribution! Could you fix the following issue(s)?

⚠ Invalid PR template

This PR does not appear to have been filed using the MLflow PR template. Please copy the PR template from here and fill it out.

Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
Copilot AI changed the title [WIP] Update PR template to encourage compact descriptions Add guidance comment to PR template encouraging compact descriptions Nov 7, 2025
Copilot AI requested a review from harupy November 7, 2025 13:37
Co-authored-by: harupy <17039389+harupy@users.noreply.github.com>
Copilot AI changed the title Add guidance comment to PR template encouraging compact descriptions Add guidance comments to PR template encouraging compact descriptions Nov 7, 2025
Copilot AI requested a review from harupy November 7, 2025 13:45
@github-actions github-actions bot added the area/docs Documentation issues label Nov 7, 2025
@harupy
Copy link
Member

harupy commented Nov 7, 2025

@copilot can you update the PR description following the updated template?

@harupy harupy added this pull request to the merge queue Nov 7, 2025
Merged via the queue into master with commit 71256a3 Nov 7, 2025
60 of 62 checks passed
@harupy harupy deleted the copilot/update-pull-request-template branch November 7, 2025 15:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/docs Documentation issues rn/none List under Small Changes in Changelogs.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants