From c4e520fd6e55e42822a7e6fe0c6177dfbe8e2c5c Mon Sep 17 00:00:00 2001 From: teknium1 Date: Thu, 5 Mar 2026 07:23:52 -0800 Subject: [PATCH] docs: add documentation & housekeeping checklist to PR template 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. --- .github/PULL_REQUEST_TEMPLATE.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e4e263c58..5496eb534 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -40,6 +40,8 @@ Fixes # +### Code + - [ ] I've read the [Contributing Guide](https://github.com/NousResearch/hermes-agent/blob/main/CONTRIBUTING.md) - [ ] My commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) (`fix(scope):`, `feat(scope):`, etc.) - [ ] I searched for [existing PRs](https://github.com/NousResearch/hermes-agent/pulls) to make sure this isn't a duplicate @@ -48,6 +50,16 @@ Fixes # - [ ] 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.example` if I added/changed config keys — or N/A +- [ ] I've updated `CONTRIBUTING.md` or `AGENTS.md` if I changed architecture or workflows — or N/A +- [ ] I've considered cross-platform impact (Windows, macOS) per the [compatibility guide](https://github.com/NousResearch/hermes-agent/blob/main/CONTRIBUTING.md#cross-platform-compatibility) — or N/A +- [ ] I've updated tool descriptions/schemas if I changed tool behavior — or N/A + ## For New Skills