docs: add PULL_REQUEST_TEMPLATE.md for consistent PR descriptions#214
Open
rafaumeu wants to merge 1 commit into
Open
docs: add PULL_REQUEST_TEMPLATE.md for consistent PR descriptions#214rafaumeu wants to merge 1 commit into
rafaumeu wants to merge 1 commit into
Conversation
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`
Contributor
6 tasks
Contributor
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughAdds a GitHub pull request template with sections for change summaries, ticket links, release notes, screenshots, testing instructions, and a completion checklist. ChangesPull request template
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a
.github/PULL_REQUEST_TEMPLATE.mdtailored for plugin contributions. The Mattermost org-level template atmattermost/.githubcovers 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-demois 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
.github/PULL_REQUEST_TEMPLATE.mdwith sections:release-note/release-note-nonefenced blocks)make test*, release notes)####headings to match the org-level template styleTicket Link
No specific issue — developer experience improvement. Originally proposed in mattermost/mattermost-plugin-github#1035 and redirected here per maintainer guidance.
Testing
PULL_REQUEST_TEMPLATE.mdChecklist
release-note-none)