Skip to content

docs: add a bug report form, issue links and a pull request template - #35

Merged
earakely-scale merged 2 commits into
mainfrom
docs/issue-and-pr-templates
Oct 1, 2026
Merged

earakely-scale merged 2 commits into
mainfrom
docs/issue-and-pr-templates

Conversation

@earakely-scale

@earakely-scale earakely-scale commented Oct 1, 2026 •

Copy link
Copy Markdown
Collaborator

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:

    • what happened, with the commands that reproduce it
    • the output and errors
    • the output of agent-env plugin list
    • the operating system and chip

    plugin list is 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 the bug label 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 matches SECURITY.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 from CONTRIBUTING.md and 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:

  • sentence-case labels, led by "What happened?"
  • plain-text labels, because GitHub doesn't render markdown there
  • render: shell for logs and render: text for the diagnostic paste, so neither needs backticks
  • kebab-case field IDs, which can later pre-fill fields from links
  • no title prefix, since the label and issue type already mark the issue as a bug

How it was tested

  • check-jsonschema passes for bug_report.yml against vendor.github-issue-forms and for config.yml against vendor.github-issue-config, using both the built-in schemas and the live SchemaStore copies. The schema includes the type key used for the issue type.
  • I loaded the YAML and printed every resolved label, description and placeholder to check what readers will see.
  • agent-env --version and agent-env plugin list give the output the form describes on 0.9.1260, the latest release.
  • Both chooser links resolve. The vulnerability form sends logged-out visitors to sign in, which GitHub requires for a private report.
  • GitHub only reads templates from the default branch. After merge I'll check that the chooser shows the form and both links, and that the community profile reports 100%.

bump-version is set so the corrected README reaches PyPI.

🤖 Generated with Claude Code

RetriggerConfidence Score: 5/5

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.

  • The bug form collects reproduction steps, output, plugin details, and operating system, with optional screenshots and a warning not to share secrets.
  • The issue chooser links questions to Discussions and vulnerabilities to private reporting while keeping blank issues enabled.
  • The pull-request template prompts for the change’s purpose and testing, with title and issue-link guidance in hidden comments.
  • The README now names PyPI as the destination for both packages.

Reviews (2) · Last reviewed commit: "docs: let a bug report attach screenshot..."

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>
@earakely-scale
earakely-scale requested a review from a team as a code owner October 1, 2026 02:15
@earakely-scale earakely-scale added documentation Improvements or additions to documentation bump-version labels Oct 1, 2026
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>
@earakely-scale
earakely-scale merged commit e3b3876 into main Oct 1, 2026
13 of 14 checks passed
@earakely-scale
earakely-scale deleted the docs/issue-and-pr-templates branch October 1, 2026 06:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bump-version documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant