Skip to content

chore: add issue template chooser and feature request form#2

Merged
tim-dickey merged 3 commits intomainfrom
feat/pr18-issue-template-chooser
Apr 4, 2026
Merged

chore: add issue template chooser and feature request form#2
tim-dickey merged 3 commits intomainfrom
feat/pr18-issue-template-chooser

Conversation

@tim-dickey
Copy link
Copy Markdown
Owner

@tim-dickey tim-dickey commented Mar 31, 2026

Adds GitHub issue template configuration to guide contributors toward structured issue submissions.

What Does This PR Add or Change?

  • .github/ISSUE_TEMPLATE/feature-request.md — a structured feature request issue template with sections for Summary, Problem Statement, Proposed Solution, Scope (agent/sub-agent/docs/evals/CI), Example Use Case, Alternatives Considered, Acceptance Criteria, and Additional Context; pre-labelled enhancement.
  • .github/ISSUE_TEMPLATE/config.yml — disables blank issues on the "New Issue" chooser and adds two contact links: one routing security vulnerabilities to private advisories and one routing Q&A/support to GitHub Discussions.

Type of Change

  • New agent
  • New sub-agent
  • Update to an existing agent or sub-agent
  • Documentation improvement
  • Bug fix

Agent/Sub-Agent Details

N/A — this PR adds GitHub issue templates, not an agent or sub-agent.

Checklist

  • I have used the official template (agents/_template/agent.md or sub-agents/_template/sub-agent.md)
  • All required frontmatter fields are filled in (no empty or "" values)
  • All required markdown sections are present
  • The ## Example Interactions section includes at least 2 real examples (agents only)
  • The folder name uses kebab-case
  • I have included a README.md in the agent/sub-agent folder
  • I have tested this agent with a real OpenClaw instance
  • This PR includes only one agent or sub-agent (keep PRs focused)

Related Issues

Testing Notes

No functional code changes. Templates take effect automatically once merged.

Screenshots or Sample Output

Copilot AI review requested due to automatic review settings March 31, 2026 01:22
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds GitHub issue template configuration to guide contributors toward structured issue submissions, including a dedicated Feature Request issue form and an issue template chooser configuration with support/security links.

Changes:

  • Added a Feature Request issue template with structured sections (summary, problem, proposed solution, scope, acceptance criteria).
  • Added .github/ISSUE_TEMPLATE/config.yml to disable blank issues and provide contact links for security reports and support questions.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
.github/ISSUE_TEMPLATE/feature-request.md Introduces a standardized feature request issue template for improvements across agents, docs, evals, and tooling.
.github/ISSUE_TEMPLATE/config.yml Configures the issue template chooser (no blank issues) and adds contact links for security and support.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

…names

- Run validate workflows on all pull requests (remove path filters on pull_request)
  so required checks always report status.
- Rename validation job names to match branch-protection required checks:
  validate-agents, validate-sub-agents, validate-evals.
- Rename markdown lint job to lint-markdown-pr-changed to match required check.
@tim-dickey
Copy link
Copy Markdown
Owner Author

@copilot apply changes based on the comments in this thread

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 31, 2026

@copilot apply changes based on the comments in this thread

Updated the PR description to summarize the two files added:

  • .github/ISSUE_TEMPLATE/feature-request.md — structured feature request form (Summary, Problem, Proposed Solution, Scope, Acceptance Criteria, etc.), pre-labelled enhancement.
  • .github/ISSUE_TEMPLATE/config.yml — disables blank issues and adds contact links routing security reports to private advisories and support questions to Discussions.

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 9 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

name: Validate Agent Templates

on:
pull_request:
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

The pull_request trigger no longer has a paths: filter, so this validation workflow will run on every PR (even when no agent-related files change). If that isn’t intentional, re-add the paths: list; if it is intentional, please call it out in the PR description since it increases CI runtime and can change which PRs are blocked by this check.

Suggested change
pull_request:
pull_request:
paths:
- 'agents/**'
- '.github/scripts/validate_agents.py'
- 'docs/agent-spec.md'
- '.github/workflows/validate-agents.yml'

Copilot uses AI. Check for mistakes.
Comment on lines 3 to 6
on:
pull_request:
paths:
- 'agents/**'
- '.github/scripts/validate_agents.py'
- 'docs/agent-spec.md'
- '.github/workflows/validate-agents.yml'
push:
branches: [main]
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

This PR is described as adding issue templates only, but it also changes CI behavior (removing PR path filters and renaming checks). Please update the PR description to reflect the workflow changes, or split the workflow edits into a separate PR to keep scope clear.

Copilot uses AI. Check for mistakes.
jobs:
validate:
name: Validate agent.md files
name: validate-agents
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

Renaming the job name changes the check-run name shown in GitHub from the previous human-readable label to validate-agents. If branch protection rules or documentation reference the old check name, they’ll need to be updated to avoid blocking merges.

Suggested change
name: validate-agents

Copilot uses AI. Check for mistakes.
name: Validate Sub-Agent Templates

on:
pull_request:
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

The pull_request trigger no longer has a paths: filter, so this workflow will run on every PR. If the intent is to keep CI focused, consider restoring the paths: list; otherwise, note the broader CI impact in the PR description.

Suggested change
pull_request:
pull_request:
paths:
- 'sub-agents/**'
- '.github/scripts/validate_sub_agents.py'
- 'docs/sub-agent-spec.md'
- '.github/workflows/validate-sub-agents.yml'

Copilot uses AI. Check for mistakes.
Comment on lines 17 to 19
validate:
name: Validate sub-agent.md files
name: validate-sub-agents
runs-on: ubuntu-latest
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

Renaming the job name changes the check-run name in GitHub (e.g., what branch protection can require). If anything relies on the old job name, update those references/settings accordingly.

Copilot uses AI. Check for mistakes.
name: validate-evals

on:
pull_request:
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

The pull_request trigger no longer has a paths: filter, so eval validation will run on every PR (not only when evals/** or related specs/scripts change). If this is intentional, it should be documented; otherwise, re-add the paths: filter to avoid unnecessary CI work.

Suggested change
pull_request:
pull_request:
paths:
- 'evals/**'
- '.github/scripts/validate_evals.py'
- 'docs/eval-fixture-spec.md'
- '.github/workflows/validate-evals.yml'

Copilot uses AI. Check for mistakes.
@@ -1,12 +1,7 @@
name: Validate Eval Fixtures
name: validate-evals
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

Workflow name was changed from a title-cased, descriptive string to validate-evals, which is inconsistent with the other workflows in this repo (e.g., Validate Agent Templates, Lint Markdown (PR Changed Files)). Consider keeping workflow names human-readable and consistent unless there’s a reason to standardize on kebab-case.

Copilot uses AI. Check for mistakes.
Comment on lines 15 to 18
jobs:
markdownlint-changed:
name: Lint changed markdown files
name: lint-markdown-pr-changed
runs-on: ubuntu-latest
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

Changing the job/step name values to kebab-case makes the Actions UI and check names less descriptive and can affect any required-status-check configuration that references the previous names. If the goal is standardization, consider applying it consistently across workflows (or keep human-readable labels for UI-facing names).

Copilot uses AI. Check for mistakes.
Comment on lines +42 to +43
- [ ]
- [ ]
Copy link

Copilot AI Mar 31, 2026

Choose a reason for hiding this comment

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

The Acceptance Criteria checklist currently contains blank items (- [ ]), which renders as empty tasks in GitHub issues. Consider adding placeholder text (e.g., - [ ] <criterion>) or removing the empty items to avoid confusion for submitters.

Suggested change
- [ ]
- [ ]
- [ ] <acceptance criterion>

Copilot uses AI. Check for mistakes.
@tim-dickey
Copy link
Copy Markdown
Owner Author

@copilot apply changes based on the comments in this thread

@tim-dickey
Copy link
Copy Markdown
Owner Author

@copilot apply changes based on the comments in this thread

- Restore paths: filters on pull_request triggers for validate-agents,
  validate-sub-agents, and validate-evals workflows
- Restore original human-readable workflow/job/step names
- Replace blank '- [ ]' acceptance criteria with '- [ ] <acceptance criterion>'

Agent-Logs-Url: https://github.com/tim-dickey/OpenClaw-agents/sessions/4f654591-38f5-43f3-8780-9a34bdf4fb1c

Co-authored-by: tim-dickey <80638631+tim-dickey@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 4, 2026

@copilot apply changes based on the comments in this thread

Applied all changes from that review thread in commit 18346aa:

  • Restored paths: filters on pull_request triggers for validate-agents.yml, validate-sub-agents.yml, and validate-evals.yml — these workflows now only run when relevant files change
  • Reverted workflow/job/step names back to the original human-readable strings (Validate Agent Templates, Validate agent.md files, Lint changed markdown files, etc.) to avoid breaking any branch protection checks that reference the old names
  • Replaced the two blank - [ ] acceptance criteria items in feature-request.md with - [ ] <acceptance criterion>

@tim-dickey tim-dickey merged commit 4abd5af into main Apr 4, 2026
1 check passed
@tim-dickey tim-dickey deleted the feat/pr18-issue-template-chooser branch April 4, 2026 22:28
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