Add structured GitHub templates based on analysis of 200+ closed PRs and 50+ closed issues to improve submission quality: Issue templates (YAML form-based): - Bug Report: requires reproduction steps, expected/actual behavior, OS/Python/Hermes version. Optional root cause analysis field. - Feature Request: requires problem/use case, links to skill-vs-tool guidance in CONTRIBUTING.md to reduce misguided tool PRs. - Setup/Installation Help: requires install method, hermes doctor output, error logs, steps already tried. - Template chooser config with links to Discord, docs, contributing guide. PR template: - Type of change selector (bug/feature/security/docs/tests/refactor/skill) - Mandatory issue reference, changes list, testing steps - Checklist: conventional commits, no duplicates, focused changes, tests pass, tests added, platform tested - Dedicated 'New Skills' section asking if skill is broadly useful and properly formatted/tested Key problems these templates address: - Bug reports with no reproduction steps or environment info - Duplicate/racing PRs (multiple people fixing same issue) - Stale branches with 85+ unrelated file changes - Junk skill PRs that should go to Skills Hub instead of bundled - Missing tests on bug fix PRs - No issue references on PRs
74 lines
2.3 KiB
YAML
74 lines
2.3 KiB
YAML
name: "✨ Feature Request"
|
|
description: Suggest a new feature or improvement.
|
|
title: "[Feature]: "
|
|
labels: ["enhancement"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for the suggestion! Before submitting, please consider:
|
|
|
|
- **Is this a new skill?** Most capabilities should be [skills, not tools](https://github.com/NousResearch/hermes-agent/blob/main/CONTRIBUTING.md#should-it-be-a-skill-or-a-tool). If it's a specialized integration (crypto, NFT, niche SaaS), it belongs on the Skills Hub, not bundled.
|
|
- **Search [existing issues](https://github.com/NousResearch/hermes-agent/issues)** — someone may have already proposed this.
|
|
|
|
- type: textarea
|
|
id: problem
|
|
attributes:
|
|
label: Problem or Use Case
|
|
description: What problem does this solve? What are you trying to do that you can't today?
|
|
placeholder: |
|
|
I'm trying to use Hermes with [provider/platform/workflow] but currently
|
|
there's no way to...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: solution
|
|
attributes:
|
|
label: Proposed Solution
|
|
description: How do you think this should work? Be as specific as you can — CLI flags, config options, UI behavior.
|
|
placeholder: |
|
|
Add a `--foo` flag to `hermes chat` that enables...
|
|
Or: Add a config key `bar.baz` that controls...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: alternatives
|
|
attributes:
|
|
label: Alternatives Considered
|
|
description: What other approaches did you consider? Why is the proposed solution better?
|
|
|
|
- type: dropdown
|
|
id: type
|
|
attributes:
|
|
label: Feature Type
|
|
options:
|
|
- New tool
|
|
- New bundled skill
|
|
- CLI improvement
|
|
- Gateway / messaging improvement
|
|
- Configuration option
|
|
- Performance / reliability
|
|
- Developer experience (tests, docs, CI)
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: scope
|
|
attributes:
|
|
label: Scope
|
|
description: How big is this change?
|
|
options:
|
|
- Small (single file, < 50 lines)
|
|
- Medium (few files, < 300 lines)
|
|
- Large (new module or significant refactor)
|
|
|
|
- type: checkboxes
|
|
id: pr-ready
|
|
attributes:
|
|
label: Contribution
|
|
options:
|
|
- label: I'd like to implement this myself and submit a PR
|