docs(agents): add a GEMINI.md pointer to the maintained instructions - #312
docs(agents): add a GEMINI.md pointer to the maintained instructions#312hyperpolymath wants to merge 1 commit into
Conversation
Adds a GEMINI.md pointer so Gemini-family agents are not blind to the repository instructions that CLAUDE.md or AGENTS.md already carries (task #50). The file is a pointer, never a duplicate of the rules. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_011eQ7hibx92N7fBDtwgReWk
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Advanced Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📜 Recent review details⏰ Context from checks skipped due to timeout. (14)
|
| Layer / File(s) | Summary |
|---|---|
Add agent guidance pointer GEMINI.md |
Adds temporary guidance for coding agents to read CLAUDE.md and retarget the pointer when AGENTS.md is added. |
Priority: ⬇️ Low
Estimated code review effort: 1 (Trivial) | ~2 minutes
Merge Risk: ⚪ Minimal · up to 63a0f
This adds a documentation pointer directing coding agents to the existing repository instructions. No current merge-readiness risk remains.
🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
| Check name | Status | Explanation |
|---|---|---|
| Docstring Coverage | ✅ Passed | No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0… |
| Linked Issues check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
| Out of Scope Changes check | ✅ Passed | Check skipped because no linked issues were found for this pull request. |
| Title check | ✅ Passed | The title clearly identifies the addition of a GEMINI.md pointer to the maintained agent instructions. It is concise and accurately reflects the main change. |
| Description check | ✅ Passed | The description directly explains the GEMINI.md pointer, its purpose, its retargeting behaviour, and the scope of the change. |
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
- Create stacked PR
- Commit on current branch
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.
A rabbit reads each line,
The patch grows clear beneath the moon,
Small changes hop in place,
Tests guard the garden path,
Reviews bloom before the dawn.
Comment @coderabbitai help to get the list of available commands.
| @@ -0,0 +1,8 @@ | |||
| # Pointer | |||
🔍 Hypatia Security ScanFindings: 56 issues detected
View findings[
{
"reason": "Stale AI session file -- delete",
"type": "stale",
"file": "GEMINI.md",
"action": "delete",
"rule_module": "root_hygiene",
"severity": "medium"
},
{
"reason": "No test directory or test files found",
"type": "no_tests",
"file": "/home/runner/work/echo-types/echo-types",
"action": "flag",
"rule_module": "honest_completion",
"severity": "high",
"deduction": 20
},
{
"reason": "Action actions/deploy-pages@v5.0.1 needs attention",
"type": "unpinned_action",
"file": "pages.yml",
"action": "pin_sha",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "Issue in label-triage.yml",
"type": "missing_timeout_minutes",
"file": "label-triage.yml",
"action": "flag",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "Issue in labels.yml",
"type": "missing_timeout_minutes",
"file": "labels.yml",
"action": "flag",
"rule_module": "workflow_audit",
"severity": "medium"
},
{
"reason": "Required file missing (condition: public_repo)",
"type": "missing_requirement",
"file": "SECURITY.md",
"action": "create",
"rule_module": "cicd_rules",
"severity": "high"
},
{
"reason": "No SECURITY.md found in echo-types",
"type": "SecurityPolicy",
"file": "/home/runner/work/echo-types/echo-types",
"action": "auto_fix",
"rule_module": "scorecard",
"severity": "medium",
"remediation": "Add SECURITY.md documenting how to report vulnerabilities.",
"scorecard_check": "Security-Policy"
},
{
"reason": "5 workflow(s) with tag-pinned (not SHA-pinned) actions in echo-types",
"type": "DependencyPinning",
"file": "/home/runner/work/echo-types/echo-types",
"action": "auto_fix",
"rule_module": "scorecard",
"severity": "medium",
"remediation": "Pin GitHub Actions and Docker base images by SHA hash.",
"scorecard_check": "Pinned-Dependencies"
},
{
"reason": "Code scanning (Scorecard): PinnedDependenciesID -- Pinned-Dependencies -- 1 day(s) old",
"type": "CSA001",
"file": ".github/workflows/push-email-notify.yml",
"action": "review",
"rule_module": "code_scanning_alerts",
"severity": "medium"
},
{
"reason": "Code scanning (Scorecard): PinnedDependenciesID -- Pinned-Dependencies -- 1 day(s) old",
"type": "CSA001",
"file": ".github/workflows/pages.yml",
"action": "review",
"rule_module": "code_scanning_alerts",
"severity": "medium"
}
]Powered by Hypatia Neurosymbolic CI/CD Intelligence |
Adds a
GEMINI.mdpointer file to this repository.Why. An estate-wide census found a large asymmetry in agent-instruction
files:
CLAUDE.mdwas present almost everywhere,GEMINI.mdin a handful ofrepositories. Any coding agent that looks for
GEMINI.mdand does not find oneproceeds with no repository-specific instructions at all.
This file is a pointer, not a second copy of the instructions. Duplicating
guidance across per-agent files guarantees the copies drift. The pointer
redirects to whichever file this repository actually maintains —
AGENTS.mdwhere one exists, otherwise
CLAUDE.md— and says to retarget it atAGENTS.mdwhen one lands.How this commit was built. The change was made with git plumbing against
origin/<default branch>, not by staging a working tree. The branch containsexactly one commit adding exactly one file, and carries none of the unrelated
local state present in this checkout. A per-repository assertion required
git diff --name-only <base> <commit>to equal the expected path set exactly,or the branch was never created.
This PR is opened as a draft on purpose. It is part of a bulk campaign and
is not requesting a merge. Review and merge at your discretion.
🤖 Generated with Claude Code
https://claude.ai/code/session_011eQ7hibx92N7fBDtwgReWk