Skip to content

Checklist logic inconsistency: replace placeholders before renaming README #28

Description

@maehr

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

  1. Follow the checklist in README.md.
  2. Replace placeholders as stated in README.md.
  3. Delete README.md as instructed.
  4. 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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions