c4e520fd6e
Add a second checklist section covering common oversights seen in PRs: - Update relevant docs (README, docs/, docstrings) - Update cli-config.yaml.example when adding config keys - Update CONTRIBUTING.md/AGENTS.md for architecture changes - Consider cross-platform impact (Windows/macOS) - Update tool schemas when changing tool behavior Each item has an 'or N/A' option so contributors aren't blocked on items that don't apply to their change.
3.0 KiB
3.0 KiB
What does this PR do?
Related Issue
Fixes #
Type of Change
- 🐛 Bug fix (non-breaking change that fixes an issue)
- ✨ New feature (non-breaking change that adds functionality)
- 🔒 Security fix
- 📝 Documentation update
- ✅ Tests (adding or improving test coverage)
- ♻️ Refactor (no behavior change)
- 🎯 New skill (bundled or hub)
Changes Made
How to Test
Checklist
Code
- I've read the Contributing Guide
- My commit messages follow Conventional Commits (
fix(scope):,feat(scope):, etc.) - I searched for existing PRs to make sure this isn't a duplicate
- My PR contains only changes related to this fix/feature (no unrelated commits)
- I've run
pytest tests/ -qand all tests pass - I've added tests for my changes (required for bug fixes, strongly encouraged for features)
- I've tested on my platform:
Documentation & Housekeeping
- I've updated relevant documentation (README,
docs/, docstrings) — or N/A - I've updated
cli-config.yaml.exampleif I added/changed config keys — or N/A - I've updated
CONTRIBUTING.mdorAGENTS.mdif I changed architecture or workflows — or N/A - I've considered cross-platform impact (Windows, macOS) per the compatibility guide — or N/A
- I've updated tool descriptions/schemas if I changed tool behavior — or N/A
For New Skills
- This skill is broadly useful to most users (if bundled) — see Contributing Guide
- SKILL.md follows the standard format (frontmatter, trigger conditions, steps, pitfalls)
- No external dependencies that aren't already available (prefer stdlib, curl, existing Hermes tools)
- I've tested the skill end-to-end:
hermes --toolsets skills -q "Use the X skill to do Y"