kefranabg/readme-md-generator

Available Scripts

Open

#41 opened on Jun 14, 2019

View on GitHub
 (10 comments) (0 reactions) (1 assignee)JavaScript (10,735 stars) (1,349 forks)batch import
enhancementgood first issue

Description

What do you think about a session Available Scripts? Getting all your scrpts commands on package.json file. Like generated apps with create-react-app.

If is ok I can try to do this.

Contributor guide

Tech stack
nodejsjavascript
Domain
clitooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic Node.js knowledgeFamiliarity with codebase structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Look at the existing README generation logic in the repository (likely in src/index.js or similar). Identify how other sections (like 'Usage', 'Installation') are added to the output. Then, parse the package.json file in the project directory to extract the 'scripts' object. Format the scripts as a list (e.g., bullet points or table) and include them in the generated README. Check the issue comments for any additional requirements or suggestions from maintainers.