Skip to content

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

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#214
rafaumeu wants to merge 1 commit into
mattermost:masterfrom
rafaumeu:docs/pr-template

Conversation

@rafaumeu

Copy link
Copy Markdown

Summary

Adds a .github/PULL_REQUEST_TEMPLATE.md tailored for plugin contributions. The Mattermost org-level template at mattermost/.github covers only Summary and Ticket Link. Plugin PRs are consistently asked for Release Notes, Testing steps, and a self-review checklist, which this template adds while preserving the org-level preamble and the #### heading style.

As suggested by @avasconcelos114 in #1035 (mattermost-plugin-github), since mattermost-plugin-demo is the source-of-truth for plugin-specific overrides, this is the appropriate place to introduce a plugin-optimized PR template that all plugin repos can inherit from.

Changes

  • Added .github/PULL_REQUEST_TEMPLATE.md with sections:
    • Summary (what and why)
    • Changes (bullet list — server/webapp/build/CI affected)
    • Ticket Link (GitHub issue or JIRA, same format as org-level)
    • Release Notes (release-note / release-note-none fenced blocks)
    • Screenshots
    • Testing (manual steps and/or automated tests)
    • Checklist (style, self-review, docs, tests, make test*, release notes)
  • Preserved the org-level preamble (contribution checklist + submitting great PRs links) so contributors keep seeing it
  • Used #### headings to match the org-level template style

Ticket Link

No specific issue — developer experience improvement. Originally proposed in mattermost/mattermost-plugin-github#1035 and redirected here per maintainer guidance.

Testing

  • Verified the file renders correctly when opening a test PR from the fork
  • Template follows the Mattermost contribution patterns observed in the org-level PULL_REQUEST_TEMPLATE.md

Checklist

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

Adds a PR template with sections for Summary, Changes, Ticket Link,
Release Notes (release-note / release-note-none), Screenshots, Testing
and a Checklist.

The Mattermost org-level template (mattermost/.github) covers only
Summary and Ticket Link. This template extends coverage with the
sections that reviewers consistently ask for on plugin PRs (Release
Notes, Testing steps, self-review checklist) while keeping the same
heading style (####) and the org-level preamble.

`release-note-none`
@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 19, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 84ff6cc3-a61a-40e1-a9e5-f2dd711df8e4

📥 Commits

Reviewing files that changed from the base of the PR and between af0d3d8 and 36cf405.

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

📝 Walkthrough

Walkthrough

Adds a GitHub pull request template with sections for change summaries, ticket links, release notes, screenshots, testing instructions, and a completion checklist.

Changes

Pull request template

Layer / File(s) Summary
Template guidance and checklist
.github/PULL_REQUEST_TEMPLATE.md
Adds structured PR documentation sections and checklist items covering review, documentation, testing, and release notes.

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

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding a PR template for consistent descriptions.
Description check ✅ Passed The description matches the changeset and explains the new pull request template in useful detail.
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