chore: add issue template chooser and feature request form#2
chore: add issue template chooser and feature request form#2tim-dickey merged 3 commits intomainfrom
Conversation
There was a problem hiding this comment.
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.ymlto 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.
|
@copilot apply changes based on the comments in this thread |
Updated the PR description to summarize the two files added:
|
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
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.
| pull_request: | |
| pull_request: | |
| paths: | |
| - 'agents/**' | |
| - '.github/scripts/validate_agents.py' | |
| - 'docs/agent-spec.md' | |
| - '.github/workflows/validate-agents.yml' |
| on: | ||
| pull_request: | ||
| paths: | ||
| - 'agents/**' | ||
| - '.github/scripts/validate_agents.py' | ||
| - 'docs/agent-spec.md' | ||
| - '.github/workflows/validate-agents.yml' | ||
| push: | ||
| branches: [main] |
There was a problem hiding this comment.
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.
| jobs: | ||
| validate: | ||
| name: Validate agent.md files | ||
| name: validate-agents |
There was a problem hiding this comment.
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.
| name: validate-agents |
| name: Validate Sub-Agent Templates | ||
|
|
||
| on: | ||
| pull_request: |
There was a problem hiding this comment.
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.
| pull_request: | |
| pull_request: | |
| paths: | |
| - 'sub-agents/**' | |
| - '.github/scripts/validate_sub_agents.py' | |
| - 'docs/sub-agent-spec.md' | |
| - '.github/workflows/validate-sub-agents.yml' |
| validate: | ||
| name: Validate sub-agent.md files | ||
| name: validate-sub-agents | ||
| runs-on: ubuntu-latest |
There was a problem hiding this comment.
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.
| name: validate-evals | ||
|
|
||
| on: | ||
| pull_request: |
There was a problem hiding this comment.
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.
| pull_request: | |
| pull_request: | |
| paths: | |
| - 'evals/**' | |
| - '.github/scripts/validate_evals.py' | |
| - 'docs/eval-fixture-spec.md' | |
| - '.github/workflows/validate-evals.yml' |
.github/workflows/validate-evals.yml
Outdated
| @@ -1,12 +1,7 @@ | |||
| name: Validate Eval Fixtures | |||
| name: validate-evals | |||
There was a problem hiding this comment.
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.
| jobs: | ||
| markdownlint-changed: | ||
| name: Lint changed markdown files | ||
| name: lint-markdown-pr-changed | ||
| runs-on: ubuntu-latest |
There was a problem hiding this comment.
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).
| - [ ] | ||
| - [ ] |
There was a problem hiding this comment.
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.
| - [ ] | |
| - [ ] | |
| - [ ] <acceptance criterion> |
|
@copilot apply changes based on the comments in this thread |
|
@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>
Applied all changes from that review thread in commit
|
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-labelledenhancement..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
Agent/Sub-Agent Details
N/A — this PR adds GitHub issue templates, not an agent or sub-agent.
Checklist
agents/_template/agent.mdorsub-agents/_template/sub-agent.md)""values)## Example Interactionssection includes at least 2 real examples (agents only)README.mdin the agent/sub-agent folderRelated Issues
Testing Notes
No functional code changes. Templates take effect automatically once merged.
Screenshots or Sample Output