Context and Goal
With the growing interaction between agents and human collaborators on GitHub issues, there's a need for an issue template that ensures tasks are scoped, concise, and actionable for both human and agent execution. Previous bounties (#15, #19) show the need for both detailed and summarized templates. This task aims to formalize a YAML template optimized for agent compatibility and reviewer clarity.
Task
Design a YAML issue template (issue_template.yml) with mandatory sections:
- Context and Goal
- Relevant references
- Component and flow mapping
- Required flows and states
- Execution Plan
- Acceptance Criteria
- Contributor and Reviewer checklist
Constraints & Expectations
- The template should keep issues strictly scoped and actionable.
- Require concise, complete responses for each section—avoid ambiguity.
- Each section must be enforced by the YAML template as required, unless technically impossible.
- Make the template structure easy to review for humans and executable for LLM agents.
- Use field types in the YAML that clarify intent—dropdowns, checklists, text as needed.
- When YAML cannot enforce a rule, document suggested standards in the template’s help text.
- Include reference to bounty guidance/templates and agent planning principles if relevant.
Acceptance Criteria
- The template can be added to
.github/ISSUE_TEMPLATE/issue_template.yml in this repository.
- All listed sections are present and clearly described.
- Fields have proper validation (required, help text, structured answers as allowed by GitHub).
- The scope-enforcing purpose and field requirements are clear to users.
Contributor and Reviewer checklist
This issue is for creating a template enabling efficient agent planning and human collaboration on tasks.
Context and Goal
With the growing interaction between agents and human collaborators on GitHub issues, there's a need for an issue template that ensures tasks are scoped, concise, and actionable for both human and agent execution. Previous bounties (#15, #19) show the need for both detailed and summarized templates. This task aims to formalize a YAML template optimized for agent compatibility and reviewer clarity.
Task
Design a YAML issue template (
issue_template.yml) with mandatory sections:Constraints & Expectations
Acceptance Criteria
.github/ISSUE_TEMPLATE/issue_template.ymlin this repository.Contributor and Reviewer checklist
This issue is for creating a template enabling efficient agent planning and human collaboration on tasks.