-
Notifications
You must be signed in to change notification settings - Fork 6
Checklist logic inconsistency: replace placeholders before renaming README #28
Copy link
Copy link
Closed
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Current Behavior
The customization checklist in README.md instructs users to replace placeholders (e.g., FULLNAME, USERNAME) in README.md, then delete README.md and rename README.template.md to README.md. If users follow this order, they will delete their edits and end up with an unedited README.
Reproduction / Steps To Reproduce
- Follow the checklist in README.md.
- Replace placeholders as stated in README.md.
- Delete README.md as instructed.
- Rename README.template.md to README.md.
Result: Changes are lost as the template file is unedited.
Anything else?
Suggested solution: Update the checklist to have users first rename README.template.md to README.md, then replace placeholders in the newly renamed file.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation