Repository navigation
docs: add a bug report form, issue links and a pull request template - #35
Merged
Merged
Conversation
The bug report form asks for what happened, the output, `agent-env plugin list` (version, install method, config and plugins) and the operating system, and applies the bug label and the Bug issue type. The template chooser sends questions to Discussions Q&A and vulnerabilities to private reporting, and keeps blank issues for everything else. The pull request template points at the title convention in CONTRIBUTING.md and asks what changed and how it was tested. The README no longer says that neither package is published: each release goes to PyPI. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
An optional Screenshots box after the output takes dragged images; the output box renders as code, so it cannot hold attachments itself. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why
GitHub's community checklist for this repo is at 75%. The two missing items are an issue template and a pull request template, and this PR adds both, keeping each small.
Bug report form (
.github/ISSUE_TEMPLATE/bug_report.yml). It has four required fields, plus an optional Screenshots box after the output. The output box renders as code, so it can't hold attachments, and the Screenshots box takes dragged images. The required fields are:agent-env plugin listplugin listis the one paste that answers the usual first questions: version, install method (uv tool, pipx, uv project or virtualenv), config file in effect, and plugins with their status. The OS dropdown makes platform bugs, such as an amd64 image on Apple Silicon, visible at a glance. The form applies thebuglabel and the Bug issue type, and warns once at the top not to paste keys, tokens or private hostnames.Template chooser (
.github/ISSUE_TEMPLATE/config.yml). It links Ask a question to Discussions Q&A, where answers can be marked, and Report a security vulnerability to private reporting, which is enabled and matchesSECURITY.md. Blank issues stay on, so feature ideas and docs problems still have a place.Pull request template (
.github/pull_request_template.md). It has two sections, What and why and How it was tested. The title convention fromCONTRIBUTING.mdand an issue-closing hint sit in HTML comments, so they don't show in the finished description.README. The Releases section said "Neither package is published to a public index yet". It now says each release publishes both packages to PyPI.
The styling follows GitHub's issue-forms conventions:
render: shellfor logs andrender: textfor the diagnostic paste, so neither needs backticksHow it was tested
check-jsonschemapasses forbug_report.ymlagainstvendor.github-issue-formsand forconfig.ymlagainstvendor.github-issue-config, using both the built-in schemas and the live SchemaStore copies. The schema includes thetypekey used for the issue type.agent-env --versionandagent-env plugin listgive the output the form describes on 0.9.1260, the latest release.bump-versionis set so the corrected README reaches PyPI.🤖 Generated with Claude Code
The PR appears safe to merge.
Summary
The PR adds GitHub forms and templates to guide bug reports, route questions and security reports, and structure pull requests. It also updates the README to say both packages ship to PyPI.
Reviews (2) · Last reviewed commit: "docs: let a bug report attach screenshot..."