Skip to content

docs: add a design-partner issue form - #83

Open
chaksaray wants to merge 1 commit into
developfrom
docs/82-design-partner-form
Open

chaksaray wants to merge 1 commit into
developfrom
docs/82-design-partner-form

Conversation

@chaksaray

Copy link
Copy Markdown
Member

Closes #82

What and why

Design partners are people who try bawbel-gate on a real agent setup and report what happened. That had no home: blank_issues_enabled is false and the existing forms are for bugs, design changes, and features. This adds .github/ISSUE_TEMPLATE/design_partner.yml (BIZ-5).

Fields: use case, environment, expected outcome (all required), what was tested, blockers (optional), and a checkbox for permission to publish the results anonymously (optional, never required). The top of the form says plainly:

No payment is implied, in either direction. Filing this creates no agreement, no commitment from either side, and no support obligation.

It also asks reporters not to include secrets, credentials, customer data, or private hostnames, to redact manifests before pasting them, and to report vulnerabilities per SECURITY.md and never in a public issue.

Differences from the plan: the file is design_partner.yml, with an underscore like the three existing forms, not design-partner.yml. No label is set, because a design-partner label does not exist in this repository and creating labels is a repository setting for the maintainer. If you want one, create it and add labels: [design-partner] to the form.

Governing spec

DESIGN.md section(s): none. This is a repository template, not behavior.

Output contract

  • Changes: one new file, an issue form
  • Does not change: code, DESIGN.md, schemas, CLI flags, manifest fields, reason strings, audit record fields
  • New or changed CLI flags, manifest fields, reason strings, audit record fields: none

Verification

pytest                          -> 346 passed in 11.17s
pytest tests/property/ -x       -> 26 passed in 1.46s
pytest tests/replay/            -> 32 passed in 0.35s
pytest tests/test_m4_corpus.py  -> 10 passed in 0.17s   (approval budget)
pre-commit run --all-files      -> ruff, bandit, trim trailing whitespace, fix end of files, check json, check yaml, check for merge conflicts: 7 Passed
check-jsonschema --builtin-schema vendor.github-issue-forms .github/ISSUE_TEMPLATE/design_partner.yml   -> ok -- validation done

The three existing forms validate the same way, as a baseline. Trial merges (git merge) with #76, #78 and #81: clean.

Not verified: how the form renders in the GitHub issue chooser. That needs the file on the default branch of the repository.

Checklist

  • Every commit carries a DCO sign-off (git commit -s)
  • DESIGN.md is still accurate after this change
  • Replay test in tests/replay/ if this blocks an attack class (not applicable)
  • Docs updated for user-facing changes
  • No em dashes in docs, comments, or error strings

🤖 Generated with Claude Code

https://claude.ai/code/session_015T9K217kxBqsUZ3omKYv9P

Design partners try bawbel-gate on a real agent setup and report what
happened. Until now that had no home: blank issues are off and the
other three forms are for bugs, design changes, and features. The form
asks for the use case, environment, expected outcome, what was tested,
and blockers, and has an optional checkbox to publish the results
anonymously. It says plainly that no payment is implied and that
vulnerabilities go through SECURITY.md.

Closes #82

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_015T9K217kxBqsUZ3omKYv9P
Signed-off-by: chaksaray <chaksaray@gmail.com>

This branch has not been deployed

No deployments
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