kefranabg/readme-md-generator

Available Scripts

Open

#41 opened on Jun 14, 2019

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

Repository metrics

Stars
 (10,735 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Look at the codebase to understand how existing sections (like Installation or Usage) are generated. Add a new section that reads the 'scripts' field from the project's package.json file and displays them in a formatted list. The section should be optional and enabled via a prompt or flag.
Tech stack
javascriptnodejs
Domain
cli
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
GitNode.jsnpm
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80