Skip to content

chore: consolidate agent context into .hermes/#18

Merged
EffortlessSteven merged 3 commits into
mainfrom
chore/hermes-index
Apr 6, 2026
Merged

chore: consolidate agent context into .hermes/#18
EffortlessSteven merged 3 commits into
mainfrom
chore/hermes-index

Conversation

@EffortlessSteven

Copy link
Copy Markdown
Member

Consolidated AGENTS.md, CLAUDE.md, GEMINI.md into single . Root files are now thin pointers.

  • — canonical repo-specific agent instructions
  • Updated — now includes agent context section
  • Root files point agents to the canonical source

Archives the full reasoning trail for landing v0.2 enhancements:
- Issue triage (#6-#13)
- Fix PRs (#14, #15, #16)
- Merge process, friction log, stats

Index in .hermes/index.md for discoverability.
AGENTS.md, CLAUDE.md, GEMINI.md were 90% identical with minor wording
differences. Canonicalized into single .hermes/agent-context.md with
thin pointer files at root for agent discovery.

Added .hermes/index.md entry for agent-context.md.
@coderabbitai

coderabbitai Bot commented Apr 6, 2026

Copy link
Copy Markdown

Warning

Rate limit exceeded

@EffortlessSteven has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 5 minutes and 57 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 5 minutes and 57 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: cb9eb636-3b8d-4ccd-b48a-feac37ae9092

📥 Commits

Reviewing files that changed from the base of the PR and between dc1e3c5 and 8df370c.

📒 Files selected for processing (5)
  • .hermes/agent-context.md
  • .hermes/index.md
  • AGENTS.md
  • CLAUDE.md
  • GEMINI.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/hermes-index

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@EffortlessSteven EffortlessSteven merged commit e470889 into main Apr 6, 2026
7 of 9 checks passed
@EffortlessSteven EffortlessSteven deleted the chore/hermes-index branch April 6, 2026 00:54

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces comprehensive agent documentation for the diffguard project, including a new canonical agent context file and updated pointers in root-level files. The review identified inconsistencies in the architecture diagram and crate purpose table within the new documentation, suggesting updates to align with the project's established style guide.

Comment thread .hermes/agent-context.md
diffguard (CLI) I/O boundary: clap, file I/O, git subprocess, env vars
diffguard-core Engine: run_check(), render_markdown_for_receipt(), compute verdicts

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The description for diffguard-core in the architecture diagram is inconsistent with the project's style guide. The style guide mentions that diffguard-core orchestrates run_check and run_sensor, and renders outputs. The current description is missing run_sensor() and uses a more specific render_markdown_for_receipt() instead of the general render outputs.

To maintain consistency with the style guide and provide accurate information, please update the description.

Suggested change
diffguard-core Engine: run_check(), render_markdown_for_receipt(), compute verdicts
diffguard-core Engine: run_check(), run_sensor(), compute verdicts, render outputs
References
  1. The style guide (line 18) defines diffguard-core as the engine that orchestrates check runs (run_check, run_sensor), computes verdicts, and renders outputs. (link)

Comment thread .hermes/agent-context.md
Comment on lines +39 to +49
| Crate | Purpose |
|-------|---------|
| `diffguard-types` | Serializable DTOs, severity/scope enums, built-in rule definitions |
| `diffguard-diff` | Parse unified diff format, handle binary/submodule/rename detection |
| `diffguard-domain` | Compile rules, evaluate lines, preprocess (mask comments/strings) |
| `diffguard-core` | Engine: check runs, verdicts, render markdown/annotations |
| `diffguard` | CLI binary: arg parsing, config loading, git invocation, file output |
| `diffguard-lsp` | LSP server for editor integration |
| `diffguard-analytics` | Trend history and analytics |
| `diffguard-testkit` | Shared test utilities, fixtures, proptest strategies |
| `xtask` | Repo automation (ci, schema, conformance) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The descriptions for diffguard-types and diffguard-core in the crate purpose table are incomplete or inconsistent compared to the project's style guide.

  • diffguard-types: The description is missing that it also contains JSON schemas, and built-in rule definitions is inaccurate as it only defines the rule structures.
  • diffguard-core: The description is missing that it also orchestrates run_sensor and the more general renders outputs is preferred over the specific render markdown/annotations.

To ensure the documentation is accurate and aligned with the style guide, please update these descriptions.

Suggested change
| Crate | Purpose |
|-------|---------|
| `diffguard-types` | Serializable DTOs, severity/scope enums, built-in rule definitions |
| `diffguard-diff` | Parse unified diff format, handle binary/submodule/rename detection |
| `diffguard-domain` | Compile rules, evaluate lines, preprocess (mask comments/strings) |
| `diffguard-core` | Engine: check runs, verdicts, render markdown/annotations |
| `diffguard` | CLI binary: arg parsing, config loading, git invocation, file output |
| `diffguard-lsp` | LSP server for editor integration |
| `diffguard-analytics` | Trend history and analytics |
| `diffguard-testkit` | Shared test utilities, fixtures, proptest strategies |
| `xtask` | Repo automation (ci, schema, conformance) |
| Crate | Purpose |
|-------|---------|
| `diffguard-types` | Serializable DTOs, enums, and JSON schemas |
| `diffguard-diff` | Parse unified diff format, handle binary/submodule/rename detection |
| `diffguard-domain` | Compile rules, evaluate lines, preprocess (mask comments/strings) |
| `diffguard-core` | Engine: orchestrates check and sensor runs, computes verdicts, renders outputs |
| `diffguard` | CLI binary: arg parsing, config loading, git invocation, file output |
| `diffguard-lsp` | LSP server for editor integration |
| `diffguard-analytics` | Trend history and analytics |
| `diffguard-testkit` | Shared test utilities, fixtures, proptest strategies |
| `xtask` | Repo automation (ci, schema, conformance) |
References
  1. The style guide defines the purpose of diffguard-core (line 18) as orchestrating check and sensor runs and rendering outputs, and diffguard-types (line 21) as containing DTOs, enums, and JSON schemas. The table's descriptions are inconsistent with these definitions. (link)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant