Skip to content

Add agent-friendly PR and issue templates#293

Merged
github-actions[bot] merged 2 commits into
mainfrom
spboyer/pr-template
May 23, 2026
Merged

Add agent-friendly PR and issue templates#293
github-actions[bot] merged 2 commits into
mainfrom
spboyer/pr-template

Conversation

@spboyer

@spboyer spboyer commented May 23, 2026

Copy link
Copy Markdown
Member

Summary

This adds lightweight GitHub templates so contributors and agents provide consistent context when opening issues and pull requests. The templates capture the why, scope, validation, documentation impact, and handoff details without introducing a heavy process.

Related issue

N/A

Agent handoff

  • Scope: Adds repository-level PR and issue templates under .github/.
  • Key files changed: .github/PULL_REQUEST_TEMPLATE.md, .github/ISSUE_TEMPLATE.md.
  • Important decisions: Kept both templates simple but complete, with explicit agent-friendly fields for scope, likely files, acceptance criteria, validation, and known gaps.
  • Follow-ups or known gaps: N/A

Type of change

  • Bug fix
  • New feature
  • Documentation update
  • Refactor or maintenance
  • CI/CD or release change

Validation

  • go test ./...
  • make lint or golangci-lint run
  • Docs site checked, if docs changed
  • Web/dashboard checks run, if web/ changed
  • Manual validation completed: checked Markdown formatting with git diff --check.
  • Not applicable; reason: code tests and web checks are not applicable because this only adds GitHub Markdown templates.

Documentation

  • README updated, if user-facing behavior changed
  • site/ docs updated, if CLI, YAML, dashboard, or validator behavior changed
  • Examples updated, if relevant
  • Not applicable

Risk and rollback

  • Risk level: Low
  • Rollback plan: Revert the template files if the repository prefers a different issue or PR intake format.

Notes for reviewers

Please review whether the requested fields strike the right balance between agent-friendly handoff detail and keeping contributor friction low.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI review requested due to automatic review settings May 23, 2026 19:46
@github-actions github-actions Bot enabled auto-merge (squash) May 23, 2026 19:46

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds lightweight, agent-friendly GitHub Markdown templates to standardize the context provided in new pull requests and issues, improving handoff clarity and reducing back-and-forth during triage and implementation.

Changes:

  • Introduces a repository PR template capturing summary, related issues, agent handoff details, validation, documentation impact, and rollback info.
  • Introduces a repository issue template capturing issue type, agent instructions, repro/expected behavior, environment details, acceptance criteria, and validation expectations.
Show a summary per file
File Description
.github/PULL_REQUEST_TEMPLATE.md Adds a structured PR intake template with validation, risk/rollback, and agent handoff fields.
.github/ISSUE_TEMPLATE.md Adds a structured issue intake template with agent instructions, repro details, and acceptance criteria.

Copilot's findings

  • Files reviewed: 2/2 changed files
  • Comments generated: 1

Comment thread .github/ISSUE_TEMPLATE.md Outdated
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions Bot merged commit e91d0ba into main May 23, 2026
5 checks passed
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.

3 participants