Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

Create a default README.md

Open
  • Is something wrong?
#16 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
38/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
javascript
Domain
documentation, tooling

Research direction

Start with the generator invoked by npx "@enhance/create@latest" ./myproject -y and inspect how files are created in the new project. Add simple default README.md and CONTRIBUTING.md files with placeholders and basic best practices, then run the command to confirm both files appear in the generated project.

Written by the indexing model from the issue text.

Description

Currently all Enhance projects created via e.g. npx "@enhance/create@latest" ./myproject -y don't have any README.md files nor CONTRIBUTING.md. I wonder if it makes sense to create a very simple default file that includes some basic best practices and placeholder for user to fill out.

wdyt?

Dominant language
JavaScript
Stars
24
Forks
2
No merged PRs in 30d

Getting set up

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 enhance-dev/create

All issues in enhance-dev/create

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.