Skip to content

docs: flag bootstrap overwrite behavior as not yet implemented #450

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jwm4 merged 1 commit into from
May 20, 2026
+2 −2
Merged

docs: flag bootstrap overwrite behavior as not yet implemented #450

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/developer-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ class BootstrapGenerator:
- `_render_template()` — Render Jinja2 template with context variables
- `_get_templates_for_language()` — Map language to template files
- `_write_file()` — Create file on disk (respects dry_run)
- `_file_exists()` — Check for conflicts (never overwrites)
- `_write_file()` — Write file to disk (⚠️ currently overwrites existing files, see [#449](https://github.com/ambient-code/agentready/issues/449))

#### 2. Bootstrap CLI (`cli/bootstrap.py`)

Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ Bootstrap is AgentReady's automated infrastructure generator. One command create
**Safe by Design**:

- Use `--dry-run` to preview changes
- Never overwrites existing files
- Never overwrites existing files (⚠️ [not yet fully implemented](https://github.com/ambient-code/agentready/issues/449), currently only `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are protected)
Copy link
Copy Markdown

@coderabbitai coderabbitai Bot May 19, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Resolve contradictory overwrite guidance in the same page

Line 101 says overwrite protection is not fully implemented, but Line 331 still says bootstrap “never overwrites files by design.” That conflict can lead users to run bootstrap with incorrect safety assumptions.

Suggested doc fix 
-**"File already exists" (Bootstrap)** — Bootstrap never overwrites files by design. Remove existing files first if regenerating.
+**"File already exists" (Bootstrap)** — Overwrite protection is not yet fully implemented (see [`#449`](https://github.com/ambient-code/agentready/issues/449)); currently only `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are protected. Use `--dry-run` and review `git status` before applying changes.
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/user-guide.md` at line 101, Update the contradictory statements so both
occurrences convey the same current behavior: replace the sentence that reads
"Never overwrites existing files (⚠️ [not yet fully implemented]..., currently
only `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are protected)" and the line
saying bootstrap “never overwrites files by design” with a single consistent
phrasing that reflects the actual state (e.g., "Bootstrap aims to avoid
overwriting files but full overwrite protection is not yet implemented —
currently only `CONTRIBUTING.md` and `CODE_OF_CONDUCT.md` are protected; see
issue `#449`"), and keep the link to the issue; ensure both the earlier mention
(the one from the diff) and the later bootstrap claim use that exact updated
text.

- Review with `git status` before committing

### When to Use Bootstrap vs Assess
Expand Down
Loading