Skip to content

Docs: clarify which files should be gitignored. #322

@jhm-ciberman

Description

@jhm-ciberman

Laravel Package Version

1.6.0

Laravel Version

12.26.3

PHP Version

8.4.12

System Info

WSL + Sail

Description

TLDR: Should the generated files (CLAUDE.md + AGENTS.md + copilot-instructions.md + .mcp.json + boost.json):

  • A. Be commited and treated as source.
  • B. Or be gitignored and treated as artifacts.

The current documentation in the README.md is not clear enough about the intended approach regarding source control and Laravel Boost.

  1. Should the AGENTS.md + CLAUDE.md + copilot-instructions.md files be committed into source control? As far as I understand, these files are regenerated from the blade files every time you run php artisan boost:install. So I imagine is intended to be excluded from source control and be regenerated with php artisan boost:install every time you do a git clone?
  2. Should php artisan boost:install be run every time a new coworker clones the project repository? Or is this intended to be a one off command similar to nova:install, telescope:install, dusk:install, etc. In that case, what is the difference with boost:update?
  3. What about boost.json? Should it be commited?

These questions are not clarified anywhere. Ironically, if you ask whatever of these questions to different LLMs, each one will ask something different because the official documentation does not explains what is the intended usage.

Steps To Reproduce

  1. Read the docs.
  2. No info is found. Laravel is generally opinionated which is good, but this intended usage is undefined.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions