Skip to content

docs: add a feature request issue template - #42

Merged
earakely-scale merged 1 commit into
mainfrom
docs/feature-request-template
Oct 1, 2026
Merged

earakely-scale merged 1 commit into
mainfrom
docs/feature-request-template

Conversation

@earakely-scale

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

Copy link
Copy Markdown
Collaborator

What and why

This adds .github/ISSUE_TEMPLATE/feature_request.md, a short Markdown template for feature ideas, next to the bug report form from #35:

  • Problem: what you're trying to do and what gets in the way
  • Proposal: what you'd like to happen, and whether it could live in a plugin rather than in core
  • Alternatives: workarounds today, or other approaches considered

An HTML comment at the top points questions to Discussions Q&A and repeats CONTRIBUTING's rule: agree the design here before writing code for anything larger than a bug fix. The template applies the enhancement label and the Feature issue type.

It's Markdown rather than a YAML form because GitHub's community checklist only counts Markdown templates. With only the bug form, "Issue templates" stays unmet. uv, Next.js, pydantic and FastAPI are in the same position, since they use only forms.

Preview

The template chooser (/issues/new/choose) lists:

Option Description
Bug report Report something in AgentEnv Framework that doesn't work as it should.
Feature request (new) Suggest a new feature or a change to how something works.
Ask a question ↗ Get help installing, configuring or using AgentEnv Framework.
Report a security vulnerability ↗ Report it privately, not in a public issue. See SECURITY.md.

GitHub also adds its own "Blank issue" link.

What the reporter starts with. Choosing Feature request pre-fills the issue body with the template. The HTML comments are visible while editing and disappear from the posted issue. The issue gets the enhancement label and the Feature type.

<!-- Questions go to Discussions Q&A. For anything larger than a bug fix, agree the design here before you write code (see CONTRIBUTING.md). -->

## Problem

<!-- What are you trying to do, and what gets in the way? -->

## Proposal

<!-- What you'd like to happen. If it could live in a plugin rather than in core, say so. -->

## Alternatives

<!-- Workarounds you use today, or other approaches you considered. -->

Example of a posted issue, using a real gap found while testing the install docs:

agent-env up should start without a config file

Problem

I want to open the explorer right after uv tool install 'agentenv-framework[explorer]', but agent-env up stops with "no .agentenv/config.toml found", even though every setting has a local default and agent-env run hello needs no config.

Proposal

Start on the local defaults when there's no config file, and print a notice naming the file to create to change them. This belongs in core, since it's the CLI's own startup.

Alternatives

Creating an empty .agentenv/config.toml first works today, but nothing tells a new user to do that.

How it was tested

  • The front matter parses to name, about, labels and type. GitHub's issue template docs list title, labels, type and assignees as the optional keys, next to the required name and about.
  • The body has the three sections, with guidance in HTML comments so it doesn't appear in a submitted issue.
  • After merge I'll check that the chooser shows both templates and the two links, and that the community checklist marks "Issue templates" as met.

🤖 Generated with Claude Code

RetriggerConfidence Score: 5/5

The PR appears safe to merge.

Summary

Adds a Markdown feature request template with prompts for describing an idea and tags for the resulting issue. Its Markdown format also supports GitHub’s community checklist, as noted in the PR description.

  • Prompts authors for the problem, proposal, and alternatives.
  • Sets the enhancement label and Feature issue type.

Reviews (1) · Last reviewed commit: "docs: add a feature request issue templa..."

A Markdown template with Problem, Proposal and Alternatives sections, labelled enhancement with the
Feature issue type. It gives feature ideas a shape next to the bug report form, and it is the kind
of template GitHub's community checklist counts: the checklist ignores YAML issue forms.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@earakely-scale earakely-scale added the documentation Improvements or additions to documentation label Oct 1, 2026
@earakely-scale
earakely-scale requested a review from a team as a code owner October 1, 2026 22:58
@earakely-scale
earakely-scale merged commit 9d19bd7 into main Oct 1, 2026
14 checks passed
@earakely-scale
earakely-scale deleted the docs/feature-request-template branch October 1, 2026 23:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants