docs: add PULL_REQUEST_TEMPLATE.md for consistent PR descriptions#1035
docs: add PULL_REQUEST_TEMPLATE.md for consistent PR descriptions#1035rafaumeu wants to merge 1 commit into
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis 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. ChangesPR Template Addition
Estimated code review effort: 1 (Trivial) | ~2 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
avasconcelos114
left a comment
There was a problem hiding this comment.
Hello! Thank you for your active interest in improving the state of the GitHub plugin 🎊
We do have a template in place that is inherited by the https://github.com/mattermost/.github repository which is the source-of-truth when it comes to issue and PR templates across all repos in the Mattermost organization
When it comes to changes to plugin repositories such as this one, there is an ongoing effort to try and keep them all in line with the https://github.com/mattermost/mattermost-plugin-demo repository by treating THAT as the source-of-truth for plugin-specific overrides, so that may be the best place to newly introduce a template that is optimized for plugin contributions (which would be awesome to have!)
Summary
Adds a
PULL_REQUEST_TEMPLATE.mdto 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
.github/PULL_REQUEST_TEMPLATE.mdwith sections:release-noteorrelease-note-none)Ticket / Issue
No specific issue — this is a developer experience improvement.
Testing
Checklist
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