Skip to content

Require a short intent line and demo video from external contributors - #7654

Merged
ComputelessComputer merged 7 commits into
mainfrom
docs/pr-demo-video-requirement
Sep 17, 2026
Merged

ComputelessComputer merged 7 commits into
mainfrom
docs/pr-demo-video-requirement

Conversation

@ComputelessComputer

@ComputelessComputer ComputelessComputer commented Sep 16, 2026

Copy link
Copy Markdown
Collaborator

Summary

Intent: External PRs only explained problem/fix in prose. Cubic already summarizes the code diff, so replace that with one short Intent line plus a required demo video/GIF, so maintainers can see what changed without reading a long write-up.

Demo

N/A, this is a docs and CI-config change to the contribution process itself with no user-facing product behavior.

Verification

Read the rendered diff for all 3 files. Tested the updated CI validation logic against 6 cases (good PR, missing intent, too-short intent, too-verbose intent, missing demo, maintainer bypass) by running the extracted check logic locally with sample PR bodies.


Summary by cubic

Tightens the external contribution flow: the PR template now asks for one short Intent line and a required Demo video/GIF instead of a Problem/Fix write-up, and agents are held to the same convention.

  • CI enforces the Intent line (20–400 chars) and Demo section for external contributors, and runs regression tests for these checks.
  • Demo accepts a video/GIF link, or "N/A" plus a one-line reason for docs-only or non-functional changes.
  • Org members, collaborators, owners, and bots remain exempt from the checks.
  • CONTRIBUTING.md documents the new template, and AGENTS.md tells agents to keep PR titles as intent and descriptions short.

Written for commit eea8361. Summary will update on new commits.

Review in cubic

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 4 files

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread .github/workflows/pr-description.yml Outdated
Comment thread .github/workflows/pr-description.yml Outdated
Comment thread .github/workflows/pr-description.yml Outdated
Comment thread .github/workflows/pr-description.yml Outdated

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed

Reply with feedback, questions, or to request a fix.

Re-trigger cubic

Comment thread .github/workflows/pr-description.yml
@ComputelessComputer
ComputelessComputer force-pushed the docs/pr-demo-video-requirement branch from 3bc2265 to 0d3cc47 Compare September 16, 2026 23:47

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All reported issues were addressed across 3 files (changes from recent commits).

Tip: Review your code locally with the cubic CLI to iterate faster.

Re-trigger cubic

Comment thread scripts/pr-description.test.mjs
ComputelessComputer and others added 6 commits September 17, 2026 14:25
Ask contributors for a short screen recording or GIF alongside the Problem/Fix summary, with an N/A escape hatch for non-functional changes.
Cubic already summarizes the code diff, so contributors only need one short Intent line plus the demo, not a two-field write-up.
Update the "Open a pull request" section to match the new template: a short Intent line plus an attached demo video/GIF, and explain why (Cubic already handles code summaries).
Replace the Problem/Fix parsing with a single Intent check (20-400 chars, so it stays short) and add the Demo section check requiring a video/GIF link or N/A plus reason.
Agents that open PRs or write commit messages here should keep the title as intent and the description as a short summary of what changed, matching the human-facing template.
Accept demo links across hosts, exclude code blocks, and require same-line N/A reasons. Correct the Intent prompt and add workflow regression tests.
@ComputelessComputer
ComputelessComputer force-pushed the docs/pr-demo-video-requirement branch from 55ac90f to 2f6fc35 Compare September 17, 2026 06:13
Test overly long intent lines and missing Demo headings.
@ComputelessComputer
ComputelessComputer merged commit 7f13bee into main Sep 17, 2026
11 checks passed
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