Always use Readme.sample.md instead of Readme.md

Open
#8 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
45/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
cli

Research direction

Start by locating the Modus CLI entry point that downloads Readme.md, then compare its behavior with README.sample.md from the linked Guidelines repository. Verify that README.sample.md becomes README.md when no other readme exists, while an existing project readme is preserved.

Written by the indexing model from the issue text.

Description

Description

Modus CLI downloads Readme.md which is a Guidelines-specific document. Instead, the CLI should automatically download README.sample.md and rename it to README.md unless another readme exists in the project

Dominant language
JavaScript
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ModusCreateOrg/modus-cli

All issues in ModusCreateOrg/modus-cli

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.