feat: import shared indico agent guidance - #14
Conversation
ba69b09 to
6bef788
Compare
OmeGak
left a comment
There was a problem hiding this comment.
There is no indication anywhere in the repo (other than the comment in .gitignore that a developer can install agent skills by running agents/indico/scripts/install-links.sh. Let's make this easier by:
- Adding a target in
Makefile - Documenting the fact that the repo is agent-enabled in
README.md
There was a problem hiding this comment.
Why not making this file also a symlink to a CLAUDE.md file in the indico-agents submodule?
There was a problem hiding this comment.
Done. CLAUDE.md now lives in the submodule and the installer symlinks it like every other shared document, so the redirect has a single source of truth. Claude resolves the @AGENTS.md import relative to the file that declares it, so the same target serves both the root and indico/. Submodule side in unconventionaldotdev/indico-agents#2.
There was a problem hiding this comment.
Anything against naming this file CONVENTIONS.md?
There was a problem hiding this comment.
Nothing against it, renamed to CONVENTIONS.md. The document covers coding, testing, style, git and PR conventions, so the broader name fits better. Submodule side in unconventionaldotdev/indico-agents#2.
| # local settings | ||
| .envrc.local | ||
|
|
||
| # per-contributor AI assistant links (installed via agents/indico/scripts/install-links.sh) |
There was a problem hiding this comment.
Let's keep this comment more general. Those directories may contain stuff other than links. Also, let's avoid references to paths that may change.
| # per-contributor AI assistant links (installed via agents/indico/scripts/install-links.sh) | |
| # local agent settings |
| /.agents/skills/ | ||
| /.claude |
There was a problem hiding this comment.
Let's stick to the same syntax as in the rest of the file.
| /.agents/skills/ | |
| /.claude | |
| .agents/skills/ | |
| .claude |
There was a problem hiding this comment.
Applied the syntax, but widened the first entry to .agents/ per your other comment.
| .envrc.local | ||
|
|
||
| # per-contributor AI assistant links (installed via agents/indico/scripts/install-links.sh) | ||
| /.agents/skills/ |
There was a problem hiding this comment.
Why ignoring only .agents/skill/ and not .agents/?
There was a problem hiding this comment.
No good reason, .agents/ is now ignored whole. Nothing under it is committed: the installer only creates skill symlinks there, and .claude points at it.
|
Both points were already in before your review landed: The rest of the feedback is addressed now. Ready for another round. |
This PR imports shared agent guidance from
unconventionaldotdev/indico-agentsas a submodule underagents/indico, and exposes its universal markdown files at host-native paths via relative symlinks.Overview
The submodule ships:
AGENTS.mdandCODING_GUIDELINES.md: shared baseline for any Indico-based host repository.indico/AGENTS.md: guidance for editing files inside the upstream Indico submodule.skills/: reusable agent skills (locate, RHs, migrations, tests, submodule bumps) consumable by any AI assistant that readsSKILL.mdfiles.scripts/install-links.sh: bootstrap that materialises symlinks idempotently.Universal symlinks are committed once. Skill symlinks are per-contributor: each teammate may use a different assistant (Claude Code, Codex, Cursor), so the chosen
*/skills/directory is gitignored.How to test
After cloning or pulling:
Verify:
readlink AGENTS.mdresolves toagents/indico/AGENTS.md.readlink indico/AGENTS.mdresolves to../agents/indico/indico/AGENTS.md.git -C indico statusis clean (the host-side symlink is added to the upstream submodule's local.git/info/exclude).ls .claude/skills/shows each shared skill as a directory symlink, and they do not appear ingit status(covered by.gitignore).See
agents/indico/HOST_INTEGRATION.mdfor the full integration model.