Skip to content

Clarify README customization checklist paths and step order#30

Merged
maehr merged 3 commits intomainfrom
copilot/implement-27-28-29
Mar 6, 2026
Merged

Clarify README customization checklist paths and step order#30
maehr merged 3 commits intomainfrom
copilot/implement-27-28-29

Conversation

Copy link
Contributor

Copilot AI commented Mar 5, 2026

Pull request

Proposed changes

The README customization checklist had two UX bugs: it referenced config.yml ambiguously 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

    • Replaced the generic config.yml label with the explicit path label:
      • [.github/ISSUE_TEMPLATE/config.yml](.github/ISSUE_TEMPLATE/config.yml)
  • Checklist workflow correction

    • Moved README file operations before placeholder replacement:
      1. delete README.md
      2. rename README.template.md to README.md
      3. run placeholder replacements in the resulting README.md and other listed files
- [ ] delete [README.md](README.md)
- [ ] rename [README.template.md](README.template.md) to [README.md](README.md)
- [ ] search and replace ... in ... [.github/ISSUE_TEMPLATE/config.yml](.github/ISSUE_TEMPLATE/config.yml)

Types of changes

  • New feature (non-breaking change which adds functionality).
  • Enhancement (non-breaking change which enhances functionality)
  • Bug Fix (non-breaking change which fixes an issue).
  • Breaking change (fix or feature that would cause existing functionality to change).

Checklist

  • I have read the README document.
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Copilot AI and others added 2 commits March 5, 2026 12:01
Co-authored-by: maehr <14755525+maehr@users.noreply.github.com>
Co-authored-by: maehr <14755525+maehr@users.noreply.github.com>
Copilot AI changed the title [WIP] Implement features for issue #27, #28, and #29 Clarify README customization checklist paths and step order Mar 5, 2026
Copilot finished work on behalf of maehr March 5, 2026 12:03
@maehr maehr marked this pull request as ready for review March 6, 2026 07:01
Copilot AI review requested due to automatic review settings March 6, 2026 07:01
@maehr maehr merged commit fbaba56 into main Mar 6, 2026
4 checks passed
@maehr maehr deleted the copilot/implement-27-28-29 branch March 6, 2026 07:02
@maehr maehr linked an issue Mar 6, 2026 that may be closed by this pull request
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

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.yml link label to use the full path .github/ISSUE_TEMPLATE/config.yml for 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)
Copy link

Copilot AI Mar 6, 2026

Choose a reason for hiding this comment

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

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]`.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Checklist logic inconsistency: replace placeholders before renaming README

3 participants