ドキュメントへの貢献

WordPress Playgroundのドキュメントサイトは、あなたのようなボランティアによって維持されています。あなたの助けを大歓迎します。

すべてのドキュメント関連の問題は、[Type] Documentationまたは[Type] Developer DocumentationとしてWordPress/wordpress-playgroundリポジトリにラベル付けされています。作業したいオープンな問題のリストをブラウズしてください。あるいは、現在のドキュメントに何かが欠けていると思う場合は、提案を議論するために問題を開いてください。

どのように貢献できますか？

プロジェクトリポジトリに問題を開くことで、追加または変更したい内容を説明して貢献できます。

もし自信があれば、問題の説明に内容を書いてください。プロジェクトの貢献者が残りの作業を引き受けます。

リポジトリをフォークし、ローカルでファイルを編集し、プルリクエストを開く

マークダウンに慣れている場合は、https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repoリポジトリをフォークし、プルリクエストを提出することで変更や新しいドキュメントページを提案できます。

WordPress/wordpress-playgroundリポジトリで翻訳されたページを持つ新しいPRを開くためのブランチを作成するプロセスは、gutenbergなどの他のWordPressリポジトリに貢献するのと同じです: https://developer.wordpress.org/block-editor/contributors/code/git-workflow/

ドキュメントファイル（.mdファイル）は、PlaygroundのGitHubリポジトリに保存されており、/packages/docs/site/docsの下にあります。

ブラウザで編集

GitHubにログインしている場合、既存のファイルを編集（または新しいファイルを追加）し、GitHub UIから直接PRを提出することもできます:

• 1. 編集したいページまたは新しいページを追加したい章のディレクトリを見つけます。
• 2. ファイルを追加ボタンをクリックして新しいファイルを追加するか、既存のファイルをクリックして鉛筆アイコンをクリックして編集します。
• 3. GitHubはリポジトリをフォークし、変更を加えた新しいブランチを作成するように求めます。
• 4. 変更を加えるためのエディタが開きます。
• 5. 完了したら、変更をコミットボタンをクリックしてプルリクエストを提出します。

これで完了です！あなたはWordPress Playgroundのドキュメントに貢献しました。

このアプローチでは、リポジトリをクローンしたり、ローカル開発環境を設定したり、コマンドを実行したりする必要はありません。

欠点は、変更をプレビューできないことです。プルリクエストを提出する前に変更を確認する方法を学ぶために読み続けてください。

ローカルプレビュー

リポジトリをクローンし、デバイス上のディレクトリに移動します。次に、以下のコマンドを実行します:

npm install
npm run build:docs
npm run dev:docs

ドキュメントサイトは新しいブラウザタブで開き、各変更ごとに自動的に更新されます。関連するファイルをコードエディタで編集し、リアルタイムで変更をテストし続けてください。