Skip to content

docs: add PULL_REQUEST_TEMPLATE.md for consistent PR descriptions#1035

Open
rafaumeu wants to merge 1 commit into
mattermost:masterfrom
rafaumeu:docs/pr-template
Open

docs: add PULL_REQUEST_TEMPLATE.md for consistent PR descriptions#1035
rafaumeu wants to merge 1 commit into
mattermost:masterfrom
rafaumeu:docs/pr-template

Conversation

@rafaumeu

@rafaumeu rafaumeu commented Jul 5, 2026

Copy link
Copy Markdown

Summary

Adds a PULL_REQUEST_TEMPLATE.md to standardize PR descriptions. Currently the plugin has no PR template, but reviewers consistently expect Summary, Changes, Release Notes, and a link to the related issue.

Changes

  • Added .github/PULL_REQUEST_TEMPLATE.md with sections:
    • Summary (what and why)
    • Changes (bullet list)
    • Ticket / Issue link (Resolves #NNN)
    • Release Notes (release-note or release-note-none)
    • Screenshots
    • Testing steps
    • Checklist

Ticket / Issue

No specific issue — this is a developer experience improvement.

Testing

  • Verified the template renders correctly on GitHub by creating a test PR from the fork
  • Template follows Mattermost contribution patterns observed in existing PRs

Checklist

  • Changes follow the project's code style guidelines
  • Self-review completed
  • Documentation updated (if applicable)
  • New tests added (if applicable)
  • All existing tests pass
  • Release notes included (or release-note-none)

Change Impact: 🟢 Low

Reasoning: This is a docs-only update that adds a pull request template and does not change runtime code, APIs, or shared logic. The blast radius is isolated to contributor workflow and has negligible regression potential.

Regression Risk: Very low; no application behavior, persistence, or critical paths are affected, and the change is limited to repository metadata used when creating PRs.

QA Recommendation: Manual QA is not required. A quick visual check on GitHub for template rendering is sufficient.
Generated by CodeRabbitAI

@rafaumeu rafaumeu requested a review from a team as a code owner July 5, 2026 03:31
@mattermost-build

Copy link
Copy Markdown
Contributor

Hello @rafaumeu,

Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here.

@coderabbitai

coderabbitai Bot commented Jul 5, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro

Run ID: d4ffd390-5863-48f7-9d45-13e43b9dc72d

📥 Commits

Reviewing files that changed from the base of the PR and between f49b3c1 and aacc5af.

📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE.md

📝 Walkthrough

Walkthrough

This PR adds a new GitHub pull request template file (.github/PULL_REQUEST_TEMPLATE.md) that provides a standardized structure for PR descriptions, including sections for summary, detailed changes, ticket reference, release notes, screenshots, testing notes, and a checklist.

Changes

PR Template Addition

Layer / File(s) Summary
Pull request template
.github/PULL_REQUEST_TEMPLATE.md
Adds standard PR template sections and a checklist covering style, self-review, docs, tests, and release notes.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Poem

A template hops into the repo today,
Guiding contributors along the way,
Checkboxes lined like carrots in a row,
With docs and tests all set to go,
Thump thump—review time's here to stay! 🐇

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the main change: adding a pull request template for consistent descriptions.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants