Skip to content

Add AGENTS.md with the layout and a "don't run the installers" rule - #13

Merged
FrancesCoronel merged 2 commits into
masterfrom
claude/repo-structure
Oct 24, 2026
Merged

FrancesCoronel merged 2 commits into
masterfrom
claude/repo-structure

Conversation

@FrancesCoronel

@FrancesCoronel FrancesCoronel commented Oct 10, 2026 •

Copy link
Copy Markdown
Owner

Why 🤔

  • The layout is easy to misread: .github/.gitconfig is the global Git config, not GitHub settings, and bin/ holds fonts and themes with no executables. Nothing warned an agent that bootstrap.sh and init/* run sudo and overwrite $HOME
  • This adds AGENTS.md with a folder map and a rule never to run the installers to test a change, and CLAUDE.md imports it

Testing 🧪

  • ➡️ Open AGENTS.md: the Layout table covers every top-level folder, and "Don't run the install scripts" says to use ShellCheck instead
  • ➡️ cat CLAUDE.md prints @AGENTS.md

Risks & Revert ⚠️

⚪️ Low risk: docs only, no script changes
🟢 This can easily be reverted, retracted, or rolled back.

Links 🔗

  • 🔧 #14 does the folder cleanup (Git config out of .github/, bin/ renamed) and is stacked on this one
  • 💬 Project thread

🤖 Generated with Claude Code

Explains what each folder holds (including that .github/.gitconfig is
the global Git config and bin/ has no executables), warns agents never
to run bootstrap.sh or init/ scripts to test a change, and points
CLAUDE.md at it.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012HeotRG6Zd1MKjxSnSmB6Z
@FrancesCoronel
FrancesCoronel marked this pull request as ready for review October 15, 2026 17:18
@chatgpt-codex-connector

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ⚠️ Failed 2026-10-15T17:18:26.286741Z 2f57df5 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector

Copy link
Copy Markdown

You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard.

@FrancesCoronel
FrancesCoronel merged commit b54880d into master Oct 24, 2026
8 checks passed
@FrancesCoronel
FrancesCoronel deleted the claude/repo-structure branch October 24, 2026 14:25
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