kefranabg/readme-md-generator

Available Scripts

Open

#41 建立於 2019年6月14日

在 GitHub 查看
 (10 留言) (0 反應) (1 負責人)JavaScript (10,735 star) (1,349 fork)batch import
enhancementgood first issue

描述

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.

貢獻者指南

技術棧
nodejsjavascript
領域
clitooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Basic Node.js knowledgeFamiliarity with codebase structure
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
50
研究方向
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.