docs: tell manual-path users to remove all generator files#3
Merged
Conversation
The scripted create-project path removes three files from the target (scripts/rename-project, scripts/create-project, and tests/test_create_project.py), but the README manual path and rename-project's printed next steps told users to delete only the rename script. Projects created via the GitHub "Use this template" button thus kept generator tooling in their first commit. Align both manual-path instructions to remove all three single-use generator files, matching what create-project does automatically. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The scripted
create-projectpath removes three files from the target —scripts/rename-project,scripts/create-project, andtests/test_create_project.py(scripts/create-project:152) — but the README manual path andrename-project's printed next steps told users to delete only the rename script. Projects created via the GitHub "Use this template" button therefore kept generator tooling (create-project+ its smoke test) in their first commit.This is a documentation defect, not a functional break — the quality gate stays green either way. Found by testing the "Use this template" button path (
gh repo create --template).Changes
rmof all three generator files, noting the preferred path removes the same three automatically.[Unreleased] › Changedentry.Verification
make checkpasses green: 65 passed, 2 skipped, 95% coverage, docs ok.🤖 Generated with Claude Code