30ff395924
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
145 lines
4.2 KiB
YAML
145 lines
4.2 KiB
YAML
name: "🐛 Bug Report"
|
|
description: Report a bug — something that's broken, crashes, or behaves incorrectly.
|
|
title: "[Bug]: "
|
|
labels: ["bug"]
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for reporting a bug! Please fill out the sections below so we can reproduce and fix it quickly.
|
|
|
|
**Before submitting**, please:
|
|
- [ ] Search [existing issues](https://github.com/NousResearch/hermes-agent/issues) to avoid duplicates
|
|
- [ ] Update to the latest version (`hermes update`) and confirm the bug still exists
|
|
|
|
- type: textarea
|
|
id: description
|
|
attributes:
|
|
label: Bug Description
|
|
description: A clear description of what's broken. Include error messages, tracebacks, or screenshots if relevant.
|
|
placeholder: |
|
|
What happened? What did you expect to happen instead?
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: reproduction
|
|
attributes:
|
|
label: Steps to Reproduce
|
|
description: Minimal steps to trigger the bug. The more specific, the faster we can fix it.
|
|
placeholder: |
|
|
1. Run `hermes chat`
|
|
2. Send the message "..."
|
|
3. Agent calls tool X
|
|
4. Error appears: ...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: expected
|
|
attributes:
|
|
label: Expected Behavior
|
|
description: What should have happened instead?
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: actual
|
|
attributes:
|
|
label: Actual Behavior
|
|
description: What actually happened? Include full error output if available.
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: component
|
|
attributes:
|
|
label: Affected Component
|
|
description: Which part of Hermes is affected?
|
|
multiple: true
|
|
options:
|
|
- CLI (interactive chat)
|
|
- Gateway (Telegram/Discord/Slack/WhatsApp)
|
|
- Setup / Installation
|
|
- Tools (terminal, file ops, web, code execution, etc.)
|
|
- Skills (skill loading, skill hub, skill guard)
|
|
- Agent Core (conversation loop, context compression, memory)
|
|
- Configuration (config.yaml, .env, hermes setup)
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: dropdown
|
|
id: platform
|
|
attributes:
|
|
label: Messaging Platform (if gateway-related)
|
|
description: Which platform adapter is affected?
|
|
multiple: true
|
|
options:
|
|
- N/A (CLI only)
|
|
- Telegram
|
|
- Discord
|
|
- Slack
|
|
- WhatsApp
|
|
|
|
- type: input
|
|
id: os
|
|
attributes:
|
|
label: Operating System
|
|
description: e.g. Ubuntu 24.04, macOS 15.2, Windows 11
|
|
placeholder: Ubuntu 24.04
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: python-version
|
|
attributes:
|
|
label: Python Version
|
|
description: Output of `python --version`
|
|
placeholder: "3.11.9"
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: hermes-version
|
|
attributes:
|
|
label: Hermes Version
|
|
description: Output of `hermes version`
|
|
placeholder: "2.1.0"
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: logs
|
|
attributes:
|
|
label: Relevant Logs / Traceback
|
|
description: Paste any error output, traceback, or log messages. This will be auto-formatted as code.
|
|
render: shell
|
|
|
|
- type: textarea
|
|
id: root-cause
|
|
attributes:
|
|
label: Root Cause Analysis (optional)
|
|
description: |
|
|
If you've dug into the code and identified the root cause, share it here.
|
|
Include file paths, line numbers, and code snippets if possible. This massively speeds up fixes.
|
|
placeholder: |
|
|
The bug is in `gateway/run.py` line 949. `len(history)` counts session_meta entries
|
|
but `agent_messages` was built from filtered history...
|
|
|
|
- type: textarea
|
|
id: proposed-fix
|
|
attributes:
|
|
label: Proposed Fix (optional)
|
|
description: If you have a fix in mind (or a PR ready), describe it here.
|
|
placeholder: |
|
|
Replace `.get()` with `.pop()` on line 289 of `gateway/platforms/base.py`
|
|
to actually clear the pending message after retrieval.
|
|
|
|
- type: checkboxes
|
|
id: pr-ready
|
|
attributes:
|
|
label: Are you willing to submit a PR for this?
|
|
options:
|
|
- label: I'd like to fix this myself and submit a PR
|