Skip to content

ECHOES-1372 Add LLM guidelines and gitar review guidelines#703

Merged
gregaubert merged 2 commits into
mainfrom
greg/agent-documentation
Jun 16, 2026
Merged

ECHOES-1372 Add LLM guidelines and gitar review guidelines#703
gregaubert merged 2 commits into
mainfrom
greg/agent-documentation

Conversation

@gregaubert

@gregaubert gregaubert commented Jun 12, 2026

Copy link
Copy Markdown
Member

Part of


Summary by Gitar

  • New AI assistant guidelines:
    • Added AGENTS.md and SKILL.md to define project-specific AI/LLM interaction patterns.
    • Added .gitar/review/ directory containing authoritative rules for automated code reviews.
  • Review standards:
    • Established strict rules covering design tokens, accessibility, Radix UI patterns, and testing conventions.
    • Included specific requirements for component folder structures, named exports, and storybook coverage.
  • Tooling configuration:
    • Updated .gitignore to include project-specific LLM context files and configuration paths.
    • Configured CLAUDE.md to point to the new AGENTS.md documentation.

This will update automatically on new commits.

@netlify

netlify Bot commented Jun 12, 2026

Copy link
Copy Markdown

Deploy Preview for echoes-react ready!

Name Link
🔨 Latest commit 65d7f33
🔍 Latest deploy log https://app.netlify.com/projects/echoes-react/deploys/6a310dffe4efa20008ee0d0e
😎 Deploy Preview https://deploy-preview-703--echoes-react.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@hashicorp-vault-sonar-prod hashicorp-vault-sonar-prod Bot changed the title Add LLM guidelines and gitar review guidelines ECHOES-1372 Add LLM guidelines and gitar review guidelines Jun 12, 2026
@hashicorp-vault-sonar-prod

hashicorp-vault-sonar-prod Bot commented Jun 12, 2026

Copy link
Copy Markdown

ECHOES-1372

Comment thread CLAUDE.md Outdated
Comment thread .agents/skills/echoes-review/SKILL.md
Comment thread .gitar/review/accessibility.md Outdated
Comment thread .gitar/review/accessibility.md Outdated
Comment thread .gitar/review/folder-and-exports.md Outdated
Comment thread .gitar/review/naming-and-api.md
Comment thread AGENTS.md
Comment thread .agents/skills/echoes-review/SKILL.md
@gregaubert gregaubert force-pushed the greg/agent-documentation branch from 316bf07 to 65d7f33 Compare June 16, 2026 08:49
@sonarqube-next

Copy link
Copy Markdown

Quality Gate passed Quality Gate passed

Issues
0 New issues
0 Fixed issues
0 Accepted issues

Measures
0 Security Hotspots
0 Dependency risks
No data about Coverage
No data about Duplication

See analysis details on SonarQube

@gregaubert gregaubert enabled auto-merge (squash) June 16, 2026 08:57

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Well done 👍

@gregaubert gregaubert merged commit de62704 into main Jun 16, 2026
11 checks passed
@gregaubert gregaubert deleted the greg/agent-documentation branch June 16, 2026 09:00
@gitar-bot

gitar-bot Bot commented Jun 16, 2026

Copy link
Copy Markdown
Code Review ✅ Approved 1 resolved / 1 findings

Documentation for LLM and review guidelines added, resolving the incorrect bare AGENT.md import in CLAUDE.md. No remaining issues found.

✅ 1 resolved
Quality: CLAUDE.md uses bare 'AGENT.md' instead of '@AGENT.md' import

📄 CLAUDE.md:1 📄 AGENT.md:1-2 📄 AGENT.md:46
CLAUDE.md contains only the literal text AGENT.md (no @ prefix, no trailing newline). Claude Code resolves file imports via the @path syntax — which AGENT.md itself uses consistently (@README.md, @package.json, @.gitar/review/naming-and-api.md). As written, CLAUDE.md will be treated as containing the literal string AGENT.md rather than importing the file, so the intended redirection from CLAUDE.md to AGENT.md may not take effect.

Suggested fix: change the content to @AGENT.md so the AGENT.md instructions are actually pulled in.

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing less information.

Comment with these commands to change:

Auto-apply Compact
gitar auto-apply:on         
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

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.

2 participants