Clarify README customization checklist paths and step order#30
Conversation
Co-authored-by: maehr <14755525+maehr@users.noreply.github.com>
Co-authored-by: maehr <14755525+maehr@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR fixes two usability issues in the README's customization checklist for the GitHub template repository: it reorders the steps so that deleting and renaming the README template happens before placeholder replacement (preventing user edits from being discarded), and it replaces the ambiguous config.yml label with the full explicit path .github/ISSUE_TEMPLATE/config.yml.
Changes:
- Reordered the checklist so "delete README.md" and "rename README.template.md" come before the search-and-replace step
- Changed the
config.ymllink label to use the full path.github/ISSUE_TEMPLATE/config.ymlfor clarity
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - [ ] search for `TODO` in the project (mostly documentation) and fix it | ||
| - [ ] delete [README.md](README.md) | ||
| - [ ] rename [README.template.md](README.template.md) to [README.md](README.md) | ||
| - [ ] search and replace `FULLNAME`, `USERNAME`, `REPO_NAME`, `SHORT_DESCRIPTION` `[INSERT CONTACT METHOD]` in [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md), [package.json](package.json), [README.md](README.md), [SECURITY.md](SECURITY.md), [.github/ISSUE_TEMPLATE/config.yml](.github/ISSUE_TEMPLATE/config.yml) |
There was a problem hiding this comment.
There is a missing comma between `SHORT_DESCRIPTION` and `[INSERT CONTACT METHOD]`. While this pre-dates this PR, since you're already editing this line, it would be good to fix it by adding a comma (and optionally "and") to make the list consistent: `SHORT_DESCRIPTION`, `[INSERT CONTACT METHOD]`.
Pull request
Proposed changes
The README customization checklist had two UX bugs: it referenced
config.ymlambiguously and instructed placeholder replacement before replacing the README template, which could discard user edits. This change makes the checklist unambiguous and reorder-safe.Checklist path clarity
config.ymllabel with the explicit path label:[.github/ISSUE_TEMPLATE/config.yml](.github/ISSUE_TEMPLATE/config.yml)Checklist workflow correction
README.mdREADME.template.mdtoREADME.mdREADME.mdand other listed filesTypes of changes
Checklist
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.