Skip to content

docs(contributing): require PR rationale and UI screenshots (MUL-8705) - #10059

Open
forrestchang wants to merge 1 commit into
mainfrom
agent/emacs/e8492947d558
Open

forrestchang wants to merge 1 commit into
mainfrom
agent/emacs/e8492947d558

Conversation

@forrestchang

Copy link
Copy Markdown
Collaborator

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)

  • Keeping one broad description prompt or only a checklist leaves the required design explanation easy to omit.
  • Updating only the template leaves contribution docs and agent instructions inconsistent.
  • An automated image-presence check cannot assess whether screenshots demonstrate the changed behavior or whether the design explanation is adequate. The requested review standard is documented for reviewers.

Related Issue

Closes MUL-8705

Type of Change

  • Documentation update

Changes Made

  • .github/PULL_REQUEST_TEMPLATE.md: required problem, proposal, alternatives, and conditional screenshot sections; verification results and AI accountability.
  • CONTRIBUTING.md and AGENTS.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

  1. git diff --check passed.
  2. A local reference check resolved all 15 added Markdown links and anchors against repository files and confirmed all six contribution locales were updated.
  3. Read the final diff to confirm the optional-screenshot wording is removed and the required/recommended distinction is consistent.

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

  • I have described the problem, the proposal, why I chose it, and why I rejected alternatives
  • I have run relevant checks and documented their results and any skipped verification
  • I have added or updated tests where applicable (not applicable to this documentation change)
  • I have attached screenshots for UI or interaction changes, or explained why screenshots are not applicable
  • I have updated relevant documentation to reflect my changes
  • If I added a new runtime / coding tool / UI tab, I synced landing copy and docs (not applicable)
  • If this PR touches Chinese product copy, I checked the development conventions
  • I have considered and documented any risks above
  • I will address all reviewer comments before requesting merge

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.

Co-authored-by: multica-agent <github@multica.ai>
@vercel

vercel Bot commented Nov 6, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
multica-docs Ready Ready Preview Nov 6, 2026 9:36am UTC

Request Review

This branch was successfully deployed

1 active deployment
Preview – multica-docs — 804a5750 Deployed Nov 6, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant