Skip to content

feat(github): add issue forms and a PR template - #1847

Merged
clay-good merged 3 commits into
mainfrom
feat/issue-and-pr-templates
Sep 29, 2026
Merged

clay-good merged 3 commits into
mainfrom
feat/issue-and-pr-templates

Conversation

@clay-good

@clay-good clay-good commented Sep 11, 2026 •

Copy link
Copy Markdown
Collaborator

Status: LGTM; ready for human review. All applicable CI checks passed on bac383ca.

Motivation

Contributors currently start with blank issue and PR descriptions. Implements step 1 of #1834.

What it does

  • Adds bug and feature forms, existing triage labels, and links to design discussions, Q&A, and Discord.
  • Adds a PR template prompting an issue/discussion link, verification, changeset, and agent disclosure.
  • Describes openspec feedback accurately: it submits immediately or provides a manual submission link. Allows an unknown version when installation fails.
  • Keeps blank issues enabled for the CLI's existing prefilled fallback URL.

Proof it works

  • YAML parsing and field validation passed against GitHub's documented form requirements; labels and discussion categories verified through GitHub's API.
  • Build, type check, lint, and all 65 feedback/tool-detection tests passed locally.
  • CI passed on Linux, macOS, and Windows, including lint/type checks and security checks. CodeRabbit completed with no inline findings.
  • git diff --check passed. Only four GitHub template files differ from the base; source, workflows, and package contents are unchanged.

Notes

No changeset needed. Feedback workflow registration and CLI form-prefill changes remain separate work in #1834. GitHub's live form rendering can be checked after merge. Hardened with Codex (GPT-6); checks run locally.

Summary by CodeRabbit

  • Documentation
    • Added structured bug report and feature request forms, including fields for describing issues, expected outcomes, and reproduction steps.
    • Added links for project discussions, setup questions, and community support, while keeping blank issue submission available.
    • Added a pull request template with prompts for change details, verification steps, and optional notes.

CONTRIBUTING asks every change to start with an issue or a discussion, but
the repository had no `.github/ISSUE_TEMPLATE/` and no PR template, so a
contributor who clones the repo and opens a PR meets a blank box and, later,
a review comment asking them to go file the issue they did not know they
needed.

- `ISSUE_TEMPLATE/bug_report.yml` asks for expected, actual, a minimal repro,
  `openspec --version`, and the agent and model, and points users who already
  have OpenSpec installed at `openspec feedback`.
- `ISSUE_TEMPLATE/feature_request.yml` asks for the problem, who it affects,
  and what was tried, and routes core-design topics to Discussions.
- `ISSUE_TEMPLATE/config.yml` keeps blank issues enabled, so the pre-filled
  URL that `openspec feedback` prints when `gh` is unavailable still works,
  and links Discussions and Discord.
- `PULL_REQUEST_TEMPLATE.md` puts `Closes #` on the first line with the
  "no issue yet?" path directly under it, catching the PR-first contributor
  at the moment they need it — no bot and no CI gate.

Labels referenced by the forms (`bug`, `enhancement`, `needs-triage`) all
exist in this repository.

Part of #1834

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
@clay-good
clay-good requested a review from a team as a code owner September 11, 2026 14:40
@clay-good
clay-good requested review from TabishB and removed request for a team September 11, 2026 14:40
@coderabbitai

coderabbitai Bot commented Sep 11, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository: Fission-AI/OpenSpec/.coderabbit.yaml

Review profile: CHILL

Plan: Advanced

Run ID: 015b3389-8cfc-47f7-93c9-fcda59a7b66f

📥 Commits

Reviewing files that changed from the base of the PR and between bac383c and 91e6573.

📒 Files selected for processing (1)
  • .github/PULL_REQUEST_TEMPLATE.md
🚧 Files skipped from review as they are similar to previous changes (1)
  • .github/PULL_REQUEST_TEMPLATE.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 4 remain after this review.


📝 Walkthrough

Walkthrough

Added GitHub issue forms for bug reports and feature requests, contact links for discussions and Discord, and a pull request template with prompts for issue links, verification, changesets, and coding-agent contributions.

Changes

Contribution intake

Layer / File(s) Summary
Issue intake forms and routing
.github/ISSUE_TEMPLATE/bug_report.yml, .github/ISSUE_TEMPLATE/feature_request.yml, .github/ISSUE_TEMPLATE/config.yml
Adds bug and feature request forms with required and optional fields, labels, blank-issue support, and contact links.
Pull request contribution guidance
.github/PULL_REQUEST_TEMPLATE.md
Adds prompts for issue links, change descriptions, verification, optional notes, changesets, and coding-agent contributions.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Feature

Merge Risk: ⚪ Minimal · up to 91e65

The existing feedback fallback remains available. No confirmed issue blocks merging.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main changes: adding GitHub issue forms and a pull request template.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

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

@alfred-openspec alfred-openspec left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

The issue forms and links are valid, but the PR template ends with a checklist item saying to name the coding agent and model below. There is no field or content below that line, so the instruction cannot be followed as written. Add an explicit agent/model field or point contributors to the Notes section, then re-request review.

@alfred-openspec alfred-openspec left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Re-reviewed at 91e6573. The prior PR-template blocker is fixed, the issue forms and links are valid, and CI is green.

@clay-good
clay-good added this pull request to the merge queue Sep 29, 2026
Merged via the queue into main with commit e923d05 Sep 29, 2026
17 checks passed
@clay-good
clay-good deleted the feat/issue-and-pr-templates branch September 29, 2026 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

design-review Needs product/design decision

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants