Document commands, their usage and documentation consistency
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 38/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 停滞
- 技術スタック
- nuxt
- 領域
- build-system, cli, documentation
調査の方向性
README package.json の例とリンク先の nuxi build-module ドキュメントから始め、次にモジュールスターターでの nuxt-module-build prepare の使用方法を、文書化されている build --stub の動作と比較します。コマンドのドキュメントを更新し、stub と prepare を説明して、記載されている一貫性の問題を解決する前に、コマンドの動作を確認してください。
索引モデルが issue の本文から書いたものです。
説明
Besides the --help output, we don't really have a place that actually documents the commands provided by nuxt-module-build, and it seems like the things that are documented are a bit fragmented/inconsistent.
-
1. In the readme
package.jsonexample, the deprecated implicit build usage is shown https://github.com/nuxt/module-builder#packagejson. -
2. Using
nuxi build-modulewill always log a warning to specify thebuildcommand explicitly, but passing thebuildargument actually does not work (not sure if local issue). -
3. The stub argument is hinted at in the documentation for
nuxi build-module(https://nuxt.com/docs/api/commands/build-module), but its function/purpose is not actually described. -
4. The module starter uses
nuxt-module-build preparewhich seems to do similar things to thenuxt-module-build build --stubaccording to its description.
I can fix point 1 and maybe point 2, but for 3 and 4 I'm honestly not sure 😅
- 主要言語
- TypeScript
- スター
- 276
- フォーク
- 35
- 平均マージ
- 2時間 46分
- マージ済み PR（30日）
- 2
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
nuxt/module-builder のほかの issue
-
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
nuxt/module-builder#801 ·
-
enhancement
難易度 3/5 1〜2日 初心者へのやさしさ 48/100
nuxt/module-builder#764 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 45/100
nuxt/module-builder#754 ·
-
Conflict between folder structure in readme (src/runtime) and TypeScript config (src/module/runtime)対応中かも @dword-design が 141 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 45/100
nuxt/module-builder#749 ·
-
Tsdown/obuild migration再び着手できるかも このイシューのプルリクエストはマージされずにクローズされました。 オープン
難易度 5/5 1週間以上 初心者へのやさしさ 25/100
nuxt/module-builder#726 · コメント 1 件 · リアクション 1 件 ·
nuxt/module-builder の issue をすべて見る
似ている issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
Nimblesite/SharpLsp#468 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
メンテナーはふだん 1 日以内に返信
-
Bundled uv is never updated and trusts the compromised eMudhra certificates対応中かも @FabienDanieau が今日担当しました。 オープンbug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
-
bg_wait's blocking mode (stopOnAttention: false) is under-documented and effectively undiscoverableオープン
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
nicobailon/pi-subagents#3019 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
db-ux-design-system/core-web#8613 ·
メンテナーはふだん 1 日以内に返信