Skip to content

Add AGENTS.md for AI coding agents - #300

Open
evnchn wants to merge 3 commits into
hkbus:masterfrom
evnchn:docs/agents-md
Open

evnchn wants to merge 3 commits into
hkbus:masterfrom
evnchn:docs/agents-md

Conversation

@evnchn

@evnchn evnchn commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

Adds AGENTS.md: onboarding for AI coding agents landing in this repo. No code, config, or workflow touched.

An agent dropped in guesses wrong: a wrong route direction is usually the crawler's fault not this repo's; yarn install needs Yarn 1 (Berry rejects the lockfile); yarn lint is red on master already; i18n keys are Chinese, not English. Each wrong guess costs a review round.

Covers: repo-family data flow/triage, src/ layout, build/lint/start commands, house rules (minimal diffs, terse comments), i18n convention, and known traps (stale service-worker builds, AppContext re-render cost, DB array mutation).

@coderabbitai

coderabbitai Bot commented Jul 28, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Added AGENTS.md with repository guidance covering project scope, data ownership, structure, commands, CI, conventions, operational traps, contribution practices, and licensing.

Changes

Repository Guidance

Layer / File(s) Summary
AI agent repository guidance
AGENTS.md
Adds documentation for repository scope, data provenance and triage, project layout, development and CI commands, formatting and i18n conventions, operational considerations, pull request expectations, and licensing.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 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.
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.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the pull request's main change: adding AGENTS.md guidance for AI coding agents.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@AGENTS.md`:
- Line 47: Update the fenced code block in AGENTS.md to include the text
language identifier, changing the opening fence to ```text while preserving the
block’s contents and closing fence.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 6c46cdb8-78ea-49e7-9e5e-b8c1f31b8219

📥 Commits

Reviewing files that changed from the base of the PR and between 328628c and 64acbb4.

📒 Files selected for processing (1)
  • AGENTS.md

Comment thread AGENTS.md Outdated
Describes the repo's role in the hkbus.app family, its build/CI gates,
house conventions, and the traps that have actually bitten, so an agent
starts from verified facts instead of guesses.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@evnchn
evnchn changed the base branch from master to alpha-release August 14, 2026 04:10
@evnchn
evnchn changed the base branch from alpha-release to master August 29, 2026 04:09
@evnchn evnchn changed the title docs: add AGENTS.md for AI coding agents Add AGENTS.md for AI coding agents Aug 30, 2026

This branch has not been deployed

No deployments
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