Skip to content

docs: Add AGENTS.md documentation for AI Agents - #23

Merged
HikaruQwQ merged 1 commit into
PolarisHackathon:mainfrom
HikaruQwQ:main
Aug 17, 2026
Merged

docs: Add AGENTS.md documentation for AI Agents#23
HikaruQwQ merged 1 commit into
PolarisHackathon:mainfrom
HikaruQwQ:main

docs: Add AGENTS.md for AI Agents

8bcb4bf
Select commit
Loading
Failed to load commit list.
Codacy Production / Codacy Static Code Analysis required action Aug 17, 2026 in 0s

23 new issues (0 max.) of at least severity.

Annotations

Check notice on line 1 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L1

No identity/persona defined. Without this, the agent has no consistent personality.

Check warning on line 1 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L1

Only 1 file found with 100+ lines. Consider splitting into modular files for better organization.

Check notice on line 9 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L9

Overly complex sentence (41 words). Break into shorter instructions.

Check notice on line 9 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L9

Undefined acronym "GSAP" — define on first use or add to glossary.

Check notice on line 92 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L92

Undefined acronym "MPA" — define on first use or add to glossary.

Check notice on line 103 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L103

Undefined acronym "SPA" — define on first use or add to glossary.

Check warning on line 132 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L132

Absolute rule without escape hatch: "- Lenis for smooth scrolling (`useLenis` hook). Must be initialized pe"

Check warning on line 133 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L133

Absolute rule without escape hatch: "- GSAP plugins must be registered before use: `gsap.registerPlugin(Scr"

Check notice on line 177 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L177

Compound instruction with 3 actions in one bullet. Split into separate items.

Check warning on line 179 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L179

Absolute rule without escape hatch: "- Additional checks on PRs: CodeRabbit, CodeQL (must all pass before m"

Check warning on line 190 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L190

Absolute rule without escape hatch: "- TypeScript `strict` mode is enabled — all types must be explicit whe"

Check warning on line 205 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L205

Absolute rule without escape hatch: "1. **Manual Testing Required**: After AI generates code, you **must** "

Check warning on line 206 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L206

Absolute rule without escape hatch: "2. **No Blind Commits**: Never commit AI-generated code without verify"

Check warning on line 210 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L210

Absolute rule without escape hatch: "> **Before asking AI to modify program files, always include this inst"

Check warning on line 216 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L216

Vague conditional: "- **Single-line `//` comments only** — and only when truly necessary for clarity". Specify exact threshold or trigger.

Check notice on line 221 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L221

Action without trigger context: "Follow the **[Conventional Commits](https://www.co". When should this happen?

Check warning on line 222 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L222

Absolute rule without escape hatch: "- Commit messages **must be written in fluent English**."

Check notice on line 230 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L230

Vague instruction: "2. Create a feature/fix branch (`feat/xxx`, `fix/xxx`, etc.) or fork to your per..."

Check warning on line 233 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L233

Absolute rule without escape hatch: "5. The PR must pass **all checks** before merge:"

Check warning on line 236 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L236

Absolute rule without escape hatch: "- CI build (lint + build must be green)"

Check warning on line 237 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L237

Absolute rule without escape hatch: "6. A repository admin or primary contributor must **approve the review"

Check notice on line 241 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L241

Undefined acronym "NOT" — define on first use or add to glossary.

Check warning on line 242 in AGENTS.md

See this annotation in the file changed.

@codacy-production codacy-production / Codacy Static Code Analysis

AGENTS.md#L242

Absolute rule without escape hatch: "- **AI accounts must NOT appear** in the collaborator list or author/c"