Describe the files git ignores in the README (task 3) #72

Merged
Tirsvad merged 1 commits from mil-009-readme into main 2026-10-08 08:21:54 +02:00
Owner

Task 3 of MIL-009 (now Accepted on main since #71): the README describes the "Git excludes" step that #71 added to create-project.sh. README only; no code or tests change.

  • Overview, sample plan output and the numbered run steps name the new step. The sample line matches what plan.sh prints.
  • A new section, "The files git ignores in the new project": the three paths (/.claude, /.agents, /AGENTS.md) and why; nothing is committed and no tracked file changes; the entries live in .git/info/exclude, so a fresh clone has neither the entries nor the files (and AGENTS.md, a copy of a template that the project edits, cannot be made again by install-skills.sh); the whole .claude and .agents folders are ignored; a path git already tracks stays tracked and is named in the summary; the step is skipped without SSH; how to track a path anyway.
  • The error table has a row for a tracked path, the code layout table describes the new roles of git.sh and framework.sh, and the known limitations say the ignored files are not shared with other clones.

Not in this PR: the tests for the new step (#68) and the version bump to 0.3.2 (#69).

Closes #67

Task 3 of MIL-009 (now `Accepted` on `main` since #71): the README describes the "Git excludes" step that #71 added to `create-project.sh`. README only; no code or tests change. - Overview, sample plan output and the numbered run steps name the new step. The sample line matches what `plan.sh` prints. - A new section, "The files git ignores in the new project": the three paths (`/.claude`, `/.agents`, `/AGENTS.md`) and why; nothing is committed and no tracked file changes; the entries live in `.git/info/exclude`, so a fresh clone has neither the entries nor the files (and `AGENTS.md`, a copy of a template that the project edits, cannot be made again by `install-skills.sh`); the whole `.claude` and `.agents` folders are ignored; a path git already tracks stays tracked and is named in the summary; the step is skipped without SSH; how to track a path anyway. - The error table has a row for a tracked path, the code layout table describes the new roles of `git.sh` and `framework.sh`, and the known limitations say the ignored files are not shared with other clones. Not in this PR: the tests for the new step (#68) and the version bump to 0.3.2 (#69). Closes #67
Tirsvad added 1 commit 2026-10-08 08:21:16 +02:00
Add the "Git excludes" step to the overview, the sample plan, the numbered
run steps and a new section: which paths are excluded and why, that nothing
is committed or changed in a tracked file, that the entries live in
.git/info/exclude and so are not shared with a clone, what happens to a path
git already tracks, and how to track one anyway. Add the tracked-path case to
the error table and the new roles of git.sh and framework.sh to the code
layout.

Closes #67
Tirsvad merged commit e23ef3a4b6 into main 2026-10-08 08:21:54 +02:00
Sign in to join this conversation.