kefranabg/readme-md-generator

Available Scripts

Open

#41 opened on 2019年6月14日

GitHub で見る
 (10 comments) (0 reactions) (1 assignee)JavaScript (10,735 stars) (1,349 forks)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
Issue 種別
feature
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.