Repository navigation
docs(contributing): require PR rationale and UI screenshots (MUL-8705) - #10059
Open
forrestchang wants to merge 1 commit into
Open
forrestchang wants to merge 1 commit into
forrestchang wants to merge 1 commit into
Conversation
Co-authored-by: multica-agent <github@multica.ai>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This branch was successfully deployed
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.
Problem (required)
Community PRs can arrive without enough context to assess the problem or design. The template calls screenshots optional even though its checklist asks for them, and it has no dedicated explanation of rejected alternatives.
Proposal and rationale (required)
Require a concrete problem statement, proposal and rationale, and rejected alternatives. UI or interaction changes must include screenshots from the running app; missing screenshots mean rejection by default. Before/after comparisons are strongly preferred. New screens still require an after screenshot, and changes without UI or interaction impact must explain why screenshots are N/A.
Put the policy in the contribution guide and make it explicit in the submission template, agent instructions, and all six contribution-page locales. Authors remain accountable for understanding and verifying AI-assisted changes. Reviewers apply the policy; this change does not add automated PR rejection.
Alternatives considered (required)
Related Issue
Closes MUL-8705
Type of Change
Changes Made
.github/PULL_REQUEST_TEMPLATE.md: required problem, proposal, alternatives, and conditional screenshot sections; verification results and AI accountability.CONTRIBUTING.mdandAGENTS.md: submission and review requirements.apps/docs/content/docs/developers/contributing*.mdx: matching requirements in English, Simplified Chinese, Traditional Chinese, Japanese, Korean, and French.How to Test
git diff --checkpassed.Application tests and the docs build were not run: this changes prose and the PR template only, with no runtime or layout changes.
Screenshots (required for UI or interaction changes)
N/A: contribution policy and template text only; no UI components, layout, or interactions change.
Checklist
AI Disclosure
AI tool used: Codex (Multica agent)
Prompt / approach: Implemented MUL-8705 by inspecting existing contribution guidance, updating the template and localized policy, and checking the diff and repository references.