Skip to content

docs: add issue templates with a Done when section - #35

Open
regislon wants to merge 3 commits into
mainfrom
collaboration-setup
Open

regislon wants to merge 3 commits into
mainfrom
collaboration-setup

Conversation

@regislon

@regislon regislon commented Nov 16, 2026 •

Copy link
Copy Markdown

Problem

Issues on this repo are free-form, so they may lack the context a reviewer needs and say nothing about when the work counts as finished.

Change

  • Two issue forms in .github/ISSUE_TEMPLATE/:
    • Feature / improvement, labelled enhancement
    • Bug report, labelled bug
  • Each has a single required Done when field split into Must have (needed to close the issue) and Nice to have (welcome, not blocking), plus short tips for writing checkable criteria.
  • Blank issues are disabled (config.yaml), so every issue goes through one of the forms.

Both labels already exist on the repo. No other files change.

Done when

Must have

  • Issue templates live on main (on merge)
  • Templates have a "Done when" section with must have vs nice to have

Testing

  • The issue-form YAML parses and pre-commit passes.
  • GitHub only lists issue templates from main, so the chooser can be checked under New issue after merge.

Impact on outputs

None.

Dependencies

None.

regislon and others added 2 commits November 16, 2026 13:04
…view labels, create-issue skill

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Move AGENTS.md, the create-issue skill and their .gitignore / pre-commit
support to a separate PR, and drop the AI review stage from CONTRIBUTING.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@regislon regislon changed the title docs: collaboration setup — issue templates, CONTRIBUTING, AGENTS, review labels, create-issue skill docs: collaboration setup — issue templates, CONTRIBUTING, needs-rebase label, main ruleset Nov 17, 2026
CONTRIBUTING, the main ruleset and the needs-rebase workflow are left
for later PRs.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@regislon regislon changed the title docs: collaboration setup — issue templates, CONTRIBUTING, needs-rebase label, main ruleset docs: add issue templates with a Done when section Nov 17, 2026
@danohu
danohu marked this pull request as ready for review November 17, 2026 15:13
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