Skip to content

Add Bootstrap section to AGENTS.md#25586

Open
mokagio wants to merge 3 commits into
trunkfrom
mokagio/agents-bootstrap
Open

Add Bootstrap section to AGENTS.md#25586
mokagio wants to merge 3 commits into
trunkfrom
mokagio/agents-bootstrap

Conversation

@mokagio
Copy link
Copy Markdown
Contributor

@mokagio mokagio commented May 26, 2026

Description

Agents reading AGENTS.md had no canonical entry point for getting the repo to a buildable state.
README.md's "Getting Started" section has it, but agents don't look there.

This adds a ## Bootstrap section near the top pointing at bundle exec rake dependencies.

I realized I needed something like this as part of my worktree workflow, becauseWordPress/Frameworks/ is gitignored and must be re-populated per worktree and my build kept failing.

Granted, a possible better solution would be to make the setup worktree-compatible somehow. But as far as I understand this is mostly a me problem and I don't think the plumbing and rewiring needed would be a net benefit. Instead, a clearer instruction set seems a net win.

Agents reading `AGENTS.md` had no canonical entry point for getting the repo to a buildable state.
The information lived in `README.md`'s "Getting Started" section but wasn't surfaced where agents look.

Surfacing `bundle exec rake dependencies` as the bootstrap command is especially useful in a worktree workflow, where `WordPress/Frameworks/` is gitignored and must be re-populated per worktree.

---

Generated with the help of Claude Code, https://code.claude.com

Co-Authored-By: Claude Code Opus 4.7 <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings May 26, 2026 09:42
@mokagio mokagio self-assigned this May 26, 2026
@mokagio mokagio added this to the 27.0 milestone May 26, 2026
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a “Bootstrap” section to AGENTS.md so automation/agents have an in-repo entry point for getting a fresh checkout/worktree into a buildable state, instead of relying on README.md.

Changes:

  • Document running the dependency bootstrap task and what it sets up (credentials, Gutenberg XCFrameworks, internal app icon).
  • Note worktree implications for WordPress/Frameworks/ and where Gutenberg downloads are cached.
  • List common Rake entry points (lint, lintfix, xcode, mocks) and point to README.md for full machine setup.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread AGENTS.md Outdated
Comment thread AGENTS.md
Comment thread AGENTS.md Outdated
Comment on lines +25 to +29
Other common task-runner entry points:

- `bundle exec rake lint` / `bundle exec rake lintfix` — SwiftLint
- `bundle exec rake xcode` — open the workspace (runs `dependencies` first)
- `bundle exec rake mocks` — start the API mock server on port 8282
Comment thread AGENTS.md Outdated
Comment thread AGENTS.md Outdated
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Gio Lodi <giovanni.lodi42@gmail.com>
Comment thread AGENTS.md
Comment thread AGENTS.md
To prepare a fresh clone or worktree to build the app, run:

```sh
rake dependencies
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

As a follow up, we could rename or alias dependencies to bootstrap which I think is a more established term for this action.

@mokagio mokagio requested review from crazytonyli and jkmassel May 26, 2026 09:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants