フレームワーク

フレームワークリポジトリへの貢献に関するいくつかの具体的な点。

一般的な貢献ガイドを読んだ後、フレームワークリポジトリへの貢献について、いくつか具体的な点を挙げます。nuxt/nuxtリポジトリ。

モノレポガイド

セットアップ

Nuxtに貢献するには、ローカル環境をセットアップする必要があります。

  1. リポジトリをご自身のGitHubアカウントにnuxt/nuxtフォークし、ローカルデバイスにクローン
  2. してください。Node.js最新の
  3. (20.x)を使用していることを確認してください。Corepackを有効にして、pnpmとyarnを使用できるようにします。
    ターミナル
    corepack enable
  4. 依存関係をpnpmでインストールするには、pnpm install --frozen-lockfileを実行します。
    ターミナル
    pnpm install --frozen-lockfile
    依存関係を追加する場合は、pnpm addを使用してください。
    pnpm-lock.yamlファイルは、すべてのNuxt依存関係の信頼できる情報源です。
  5. 受動開発システムをアクティブ化します。
    ターミナル
    pnpm dev:prepare
  6. 変更をコミットできるブランチをチェックアウトします。
    ターミナル
    git checkout -b my-new-branch

次に、プルリクエストを送信する前に、プレイグラウンドとテストで変更をテストしてください。

プレイグラウンド

プルリクエストに取り組んでいる間は、変更が正しく機能しているかを確認したいと思うでしょう。

playground/内のサンプルアプリを変更し、実行することができます。

ターミナル
pnpm dev
ご自身のブランチにコミットしないように注意してください。しかし、PRの説明にいくつかのサンプルコードを追加することは役立つかもしれません。これは、レビュアーや他のNuxtユーザーが、あなたが構築した機能を深く理解するのに役立ちます。

テスト

すべての新機能には、対応する単体テスト（可能であれば）が必要です。このリポジトリのtest/ディレクトリは現在開発中ですが、既存の例に倣って新しいテストを作成するよう最善を尽くしてください。

PRを作成したり、レビュー準備完了としてマークしたりする前に、すべてのテストがパスすることを確認してください。

ターミナル
pnpm test

Linting

すでに気づいているかもしれませんが、私たちはESLintを使用してコーディング標準を強制しています。

変更をコミットする前に、コードスタイルが正しいことを確認するために、次を実行してください。

ターミナル
pnpm lint
pnpm lint --fixを使用して、ほとんどのスタイル変更を修正できます。
それでもエラーが残っている場合は、手動で修正する必要があります。

ドキュメント

新しい機能を追加したり、リファクタリングしたり、その他の方法でNuxtの動作を変更したりする場合、変更点を文書化する必要があるでしょう。ドキュメントへの変更は、同じPRに含めてください。最初のコミットでドキュメントを記述する必要はありませんが（ただし、プルリクエストが十分に成熟したらすぐにそうしてください）。

ドキュメンテーションスタイルガイドに従って変更を加えてください。

最終チェックリスト

PRを提出する際には、記入する必要がある簡単なテンプレートがあります。チェックリストの適切な「回答」にすべてチェックを入れてください。

ドキュメントガイド

ドキュメントやエラーメッセージを改善できる箇所を見つけた場合は、たとえ誤字修正のためであっても、PRをオープンしてください！

ドキュメンテーションスタイルガイドに従って変更を加えてください。

クイック編集

誤字を発見したり、文章を言い換えたい場合は、右側の「Community」セクションにある「Edit this page」リンクをクリックしてください。

GitHubインターフェースで直接変更を行い、プルリクエストを開いてください。

長めの編集

ドキュメントコンテンツは、リポジトリのdocs/ディレクトリ内にあり、Markdownで記述されています。nuxt/nuxtリポジトリとマークダウンで書かれています。

ドキュメントをローカルでプレビューするには、nuxt/nuxt.comリポジトリ。
の手順に従ってください。VS CodeのMDC拡張機能

をインストールすることをお勧めします。

ドキュメントのLintingドキュメントはGlobalComponentsMarkdownLintcase police

ターミナル
pnpm lint:docs
を使用してlintされ、ドキュメントの整合性を保っています。また、pnpm lint:docs:fixを実行して、lintの問題を強調表示し解決することもできます。

PRを開く

PRのタイトルが従来のコミットガイドラインに準拠していることを確認してください。

PRタイトルの例
docs: update the section about the nuxt.config.ts file