Repository navigation
Add AI-agent operating manual, reference docs, skills, rules, and guardrails - #3850
Merged
Merged
Conversation
This was referenced Jul 17, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Makes the repository AI-agent-friendly by adding an in-repo guidance system that also
serves human contributors: an operating manual, reference docs, task skills, coding
rules, and an enforced guardrail. Documentation and tooling only — no production or
public-API changes.
Key Decisions & Assumptions
.agents/(docs, rules, skills); tool-specificfiles (
CLAUDE.md,.claude/) are thin bridges/symlinks into it, so each fact isedited in one place.
remain under
docs/(MkDocs); agents read the.agents/copies.committing/pushing or creating/commenting on PRs and issues (a written guardrail);
the add-a-command skill stops for human review before code generation.
Behavioral / Conceptual Changes
AGENTS.mdoperating manual +CLAUDE.mdthat imports it (@AGENTS.md)..agents/docs/: architecture (command flow, code generation,cluster broadcast/aggregation, connections/threading/errors), a code-generation
runbook, integration-testing notes (base+overload test pattern), and Javadoc
conventions.
adding-a-redis-command,writing-javadoc,draft-pr-description..agents/rules/(Java style), bridged into.claude/rules/.docs/integration-testing.md: single-test example corrected to-Dit.test.Note
Low Risk
Documentation and agent configuration only; the sole user-facing doc tweak is a Maven flag correction with no runtime impact.
Overview
Adds an in-repo AI-agent guidance system (documentation and tooling only — no client/runtime changes): root
AGENTS.mdoperating manual,CLAUDE.mdthat imports it, and a tool-neutral tree under.agents/(reference docs, Java rules, task skills) with.claude/as thin bridges/symlinks.Reference docs cover command flow and codegen pitfalls (templates vs generated APIs, sync proxy vs reactive impl), a safe API-generator runbook, integration-test notes (Failsafe
-Dit.test, base+overload pattern), and Javadoc house style. Skills spell out end-to-end workflows: add a Redis command (with a human review stop before generation), write Javadoc, and draft PR text toprDescription.md.Guardrails in
AGENTS.mdforbid agents from commit/push and from GitHub PR/issue actions;prDescription.mdis gitignored. Published contributor docs get one fix: the “run one integration test” example indocs/integration-testing.mdnow uses-Dit.testinstead of-Dtest.Reviewed by Cursor Bugbot for commit 0c54df7. Bugbot is set up for automated code reviews on this repo. Configure here.