Skip to content

feat: add design partner reporting loop#485

Merged
mohanagy merged 2 commits into
nextfrom
issue-472-design-partner-feedback-loop
Jun 2, 2026
Merged

feat: add design partner reporting loop#485
mohanagy merged 2 commits into
nextfrom
issue-472-design-partner-feedback-loop

Conversation

@mohanagy
Copy link
Copy Markdown
Owner

@mohanagy mohanagy commented Jun 2, 2026

Summary\n- add a share-safe design-partner program guide, public 10-slot tracker, and follow-up issue tagging rules\n- add a GitHub issue form for design-partner receipts and link the program from README/getting-started/roadmap\n- lock the new docs surface with focused Vitest coverage\n\n## Testing\n- npm run typecheck\n- npm run build\n- CI=1 npm run test:run\n\nRefs #472

Summary by CodeRabbit

  • Documentation

    • Added comprehensive design partner program docs with share-safe guidelines, receipt templates, workflow, and public tracker; added README and getting-started links and roadmap entry referencing the program.
    • Added a GitHub issue template for submitting design partner reports with required fields and privacy guidance.
  • Tests

    • Added unit tests to verify documentation, tracker entries, and issue-template contents.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Jun 2, 2026

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 3f5d13e9-ef03-4a71-95d5-6661ebff819b

📥 Commits

Reviewing files that changed from the base of the PR and between 34fb89b and eb7af59.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/design_partner_report.yml
  • tests/unit/design-partners-doc.test.ts
🚧 Files skipped from review as they are similar to previous changes (2)
  • .github/ISSUE_TEMPLATE/design_partner_report.yml
  • tests/unit/design-partners-doc.test.ts

📝 Walkthrough

Walkthrough

This PR adds a design-partner program: a new guide with share-safe receipt workflows, a GitHub issue template for reports, README/roadmap/tutorial links, and unit tests validating the guide, template, tracker, and cross-references.

Changes

Design Partner Program and Documentation

Layer / File(s) Summary
Design Partner Program Guide and Process Definition
docs/design-partners.md
New document defining the design-partner program purpose, share-safe boundary rules (excluding source paths, code, secrets, private prompts), a six-step evaluation workflow, standardized receipt template with required fields, a public tracker table for ten target receipts (DP-01 through DP-10), and rules for converting receipts into labeled follow-up issues tied to product gaps.
Design Partner Report Issue Template
.github/ISSUE_TEMPLATE/design_partner_report.yml
New GitHub issue template with required fields for repo metadata, agent runtime, task type, baseline and Madar command shapes, results, metrics, caveats, and required follow-up issue links. Includes share-safe submission guidance and applies design-partner and type:product labels.
Documentation Cross-References and Integration
README.md, docs/roadmap.md, docs/tutorials/getting-started.md
Small updates linking and referencing the design-partner program from the README documentation table, roadmap v0.30 (issue #472), and the getting-started tutorial to improve discoverability.
Design Partner Program Validation Tests
tests/unit/design-partners-doc.test.ts, tests/unit/roadmap-docs.test.ts
New and updated Vitest unit tests that validate the design-partners guide content (required headings, exact tracker row count of 10), issue template keys and share-safe guidance, and cross-document references (README, getting-started, and roadmap assertions for issues/472 and design-partner reports).

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

  • mohanagy/madar#458: Updates the same design-partner documentation surfaces in docs/roadmap.md and tests/unit/roadmap-docs.test.ts.
  • mohanagy/madar#334: Modifies roadmap and its unit validation by adding new issue-link entries and related phrasing.

🐰 A program for partners fair,
Share-safe receipts we craft with care,
Ten slots to shine, no secrets bare,
Real feedback flows through madar's air!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title 'feat: add design partner reporting loop' accurately summarizes the main change: introducing a new design partner reporting workflow with templates, documentation, and tracking.
Description check ✅ Passed The description covers all required sections: summary of changes, testing commands, and references related issue #472. All checklist items appear to be addressed by the PR content.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch issue-472-design-partner-feedback-loop

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In @.github/ISSUE_TEMPLATE/design_partner_report.yml:
- Line 34: The YAML parser fails because the description value contains colons
and isn't quoted; update the issue template by wrapping the description field's
value for the "description" key (the line currently reading: description:
Example: NestJS + Prisma, Next.js app router, Express API, monorepo service +
web.) in quotes (single or double) so it becomes a valid YAML string for the
description property.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 79a7b237-80b8-46f5-9e94-42265da6f694

📥 Commits

Reviewing files that changed from the base of the PR and between 74aa855 and 34fb89b.

📒 Files selected for processing (7)
  • .github/ISSUE_TEMPLATE/design_partner_report.yml
  • README.md
  • docs/design-partners.md
  • docs/roadmap.md
  • docs/tutorials/getting-started.md
  • tests/unit/design-partners-doc.test.ts
  • tests/unit/roadmap-docs.test.ts

Comment thread .github/ISSUE_TEMPLATE/design_partner_report.yml Outdated
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@mohanagy mohanagy merged commit 5158392 into next Jun 2, 2026
7 checks passed
@mohanagy mohanagy deleted the issue-472-design-partner-feedback-loop branch June 2, 2026 21:33
@coderabbitai coderabbitai Bot mentioned this pull request Jun 3, 2026
3 tasks
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