Skip to content

chore(github): ask reporters for a version, install method and steps with issue forms - #877

Open
Laptopmini wants to merge 2 commits into
CopilotKit:mainfrom
Laptopmini:issue-forms
Open

Laptopmini wants to merge 2 commits into
CopilotKit:mainfrom
Laptopmini:issue-forms

Conversation

@Laptopmini

@Laptopmini Laptopmini commented Oct 28, 2026 •

Copy link
Copy Markdown

What this changes

Adds issue forms under .github/ISSUE_TEMPLATE/: a bug report, a feature request and a documentation form, plus a config.yml for the issue chooser.

Several open issues are missing what you'd need to act on them: #835 and #837 are titled "123" and empty, #854 is one line with no steps, and #866 reports a version (0.52.1) that isn't a public release. The bug form asks for what those left out:

  • Required: what happened, steps to reproduce, what you expected, the version (release, image tag or commit), and how OpenBot is run (desktop app, published image, Helm chart, from a clone).
  • Optional: where it happens (web, desktop, Android, iOS, Slack, Teams, server only), which Intelligence the deployment uses (managed, local, self-hosted), OS and browser, and logs, with a reminder to remove keys, tokens and personal data first.

The feature form asks for the problem, the proposal, alternatives, and whether the reporter wants to work on it. The docs form asks for the page and what's wrong.

config.yml only points to what already exists: private vulnerability reporting (enabled in #684) and the docs/ folder.

Three choices you may want to change:

  • blank_issues_enabled: false. This stops empty issues like 123 #835 and 123 #837. Flip it to true if you want to keep blank issues.
  • Title prefixes. Each form prefills the title the way CopilotKit's do (🐛 Bug: , 🚀 Feature Request: , 📚 Documentation: ), so the type shows in the issue list without labels. Remove the title: line from a form to start with an empty title instead.
  • No labels. The forms apply none, since the repo's labels are mostly unused. Adding labels: ["bug"] (or enhancement, documentation) to a form is a one-line change if you want them.

What this deliberately leaves out: CONTRIBUTING.md, a code of conduct and SECURITY.md. Per #700, those are commitments the team makes, so they're yours to write. Nothing here promises response times or names a contact the team hasn't already set up.

Where it runs

Nowhere at runtime. These are GitHub repository files and don't ship in the image, the desktop app or the chart.

  • New state that outlives a request? None.
  • What happens on the second replica? Nothing changes.
  • Anything serialised? None.
  • Anything fanned out to a browser? None.
  • New listener, port, or schedule? None.

Boundary and audit

  • Every acting call still goes through the gateway: no server code changed.
  • New refusals and new failures each write a row: none added.
  • Nothing new is trusted from the client: no server code changed.

Changelog

  • No entry: a deployment behaves no differently afterwards. This only changes the new-issue page on GitHub.

Proof

  • Validated all four files against SchemaStore's GitHub schemas (github-issue-forms.json and github-issue-config.json) with Ajv 8: all valid. A deliberately broken copy (a dropdown with no options and an id containing a space) is rejected, so the check catches real mistakes.
  • Checked both config.yml links: the docs/ tree answers 200, and private vulnerability reporting is enabled on the repo (GET /repos/CopilotKit/OpenBot/private-vulnerability-reporting returns enabled: true).
  • Checked how GitHub renders them on a fork with this branch as its default: the chooser lists the three forms and both links, and the bug form's fields and dropdowns display as intended. With blank issues off, people with write access still see a "Maintainers only" blank issue option; everyone else gets the forms.

Add bug report, feature request and documentation forms, and route
security reports to private vulnerability reporting from the issue
chooser. The bug form asks for the release or commit, how OpenBot is
run, where the bug happens and which Intelligence the deployment uses,
which several open issues left out.
@Laptopmini Laptopmini changed the title Ask reporters for a version, install method and steps with issue forms chore(github): ask reporters for a version, install method and steps with issue forms Oct 28, 2026

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