ドキュメントの貢献
WordPress Playground のドキュメント サイト は、あなたのようなボランティアによって管理されており、皆さんの協力をお待ちしています。
ドキュメント関連の課題はすべて、[Type] Documentation または [Type] Developer Documentation というラベルが付けられ、WordPress/wordpress-playground リポジトリに保存されています。未解決の課題の一覧から、取り組みたい課題を見つけてください。また、現在のドキュメントに不足している点があると思われる場合は、課題を開いてご提案を議論してください。
どうすれば貢献できますか?
プロジェクト リポジトリで問題を開く ことで、追加または変更したい内容を説明して貢献できます。
気が向いたら、問題の説明に内容を書いてください。残りの作業はプロジェクトの貢献者が行います。
リポジトリをフォークし、ローカルでファイルを編集し、プルリクエストを開く
Markdown に精通している場合は、wordpress-playground リポジトリを フォーク し、Pull Request を送信して変更や新しいドキュメント ページを提案することができます。
WordPress/wordpress-playground リポジトリでブランチを作成し、翻訳されたページを含む新しい PR を開くプロセスは、gutenberg などの他の WordPress リポジトリに貢献する場合と同じです。 https://developer.wordpress.org/block-editor/contributors/code/git-workflow/
ドキュメント ファイル (.md ファイル) は、Playground の GitHub リポジトリに保存されています。英語の場合は /packages/docs/site/docs、その他の言語の場合は /packages/docs/site/i18n に保存されています。
ブラウザで編集する
GitHub にログインしている場合は、既存のファイルを編集 (または新しいファイルを追加) し、GitHub UI から 直接 PR を送信することもできます。
- 編集したいページ、または新しいページを追加したい章のディレクトリを見つけます。
- ファイルを追加 ボタンをクリックして新しいファイルを追加するか、既存のファイルをクリックしてから鉛筆アイコンをクリックして編集します。
- GitHub からリポジトリをフォークして、変更内容を含む新しいブランチを作成するように求められます。
- 変更を加えるためのエディターが開きます。
- 完了したら、変更をコミット ボタンをクリックしてプルリクエストを送信します。
これで完了です。WordPress Playground のドキュメントに貢献できました。
このアプローチでは、リポジトリのクローンを作成したり、ローカル開発環境をセットアップしたり、コマンドを実行したりする必要はありません。
欠点は、変更内容をプレビューできないことです。プルリクエストを送信する前に変更内容を確認する方法については、読み進めてください。
ローカルプレビュー
リポジトリをクローンし、デバイス上のディレクトリに移動します。以下のコマンドを実行します。
npm install
npm run build:docs
npm run dev:docs
ドキュメントサイトは新しいブラウザタブで開き、変更ごとに自動的に更新されます。コードエディタで関連ファイルを編集し、変更内容をリアルタイムでテストしてください。