GitHub Docs へのコントリビューション

GitHub ドキュメントはオープンソースです。 誰でもパブリック docs リポジトリのドキュメントにコントリビューションできます: https://github.com/github/docs 。GitHub の従業員は、docs-internal という名前のこのリポジトリのコピーでドキュメントを作成しています。 2 つのリポジトリは自動的に同期され、両方とも最新の状態に保たれ、変更がいずれかのリポジトリの main ブランチにマージされます。 わかりやすくするために、GitHub Docs へのコントリビューションに関する記事の「ドキュメント リポジトリ」を参照します。

ドキュメント リポジトリは、docs.github.com で公開されているドキュメントについて議論し、共同作業を行う場所です。

問題

Issue は、共同作成者が支援できるタスクを追跡するために使用されます。 Issue に triage ラベルがある場合は、私たちがまだ確認していないので、作業を開始しないでください。

ドキュメント コンテンツや docs.github.com Web サイトに関する更新する必要がある内容を見つけた場合は、未解決の Issue を検索して、他の人が同じことを報告しているかどうかを確認してください。 それが新しい場合は、テンプレートを使って Issue を開いてください。 Issue を使用して、修正したい問題について会話します。

Pull Request

pull request は、リポジトリの変更を提案する方法です。 これらの変更をマージすると、24 時間以内にライブ サイトに展開されます。

REST API リファレンス ドキュメントへのコントリビューションは受け入れることができません。 REST API リファレンス ドキュメントに誤りがある場合は、rest-api-description リポジトリで Issue を開いてください。

GitHub の製品、機能、ツール、拡張情報のみを文書化します。 機能の動作を示すためにサードパーティ製ツールにメンションまたはリンクできますが、GitHub でコード開発されていない限り、サード パーティのツールまたは統合を文書化するための pull request は受け付けません。

自分自身の pull request のレビュー

pull request を他のユーザーがレビューできるようにマークする前に、最初に必ず自分自身の pull request をレビューする必要があります。

コンテンツの変更については、次の点を確認してください。

• 変更がコンテンツ設計計画で概説されているユーザー エクスペリエンスと目標を満たしていることを確認してください (存在する場合)。
• 技術的な正確性については、コンテンツをレビューしてください。
• 文法、スペル、「スタイル ガイド」への準拠に関する変更を確認してください。
• pull request のテキストが簡単に翻訳できることを確認してください。 詳しくは、「翻訳するコンテンツの記述」を参照してください。
• 新しい、または更新された Liquid ステートメントを確認して、バージョン管理が正しいことを確認してください。 詳しくは、「バージョン管理に関するドキュメント」を参照してください。
• 変更したすべてのページのプレビューを確認してください。 プレビューは、pull request を送信した後に自動的に生成され、pull request にリンクが追加されます。 プレビューは、表示する準備が整うまでに数分かかる場合があります。 すべてが期待どおりにレンダリングされていることを確認してください。 プレビューを確認すると、入力ミス、スタイル ガイドに従っていないコンテンツ、バージョン管理の問題が原因でレンダリングされないコンテンツなどの問題の特定に役立ちます。 リストとテーブルのレンダリングされた出力を確認してください。Markdown では識別が難しい問題が発生していることがあります。
• pull request に失敗したチェックがある場合は、それらがすべて成功するまでトラブルシューティングを行ってください。

サポート

私たちは、絶えず変化する製品のドキュメントの要求に追いつくために懸命に取り組んでいる小さなチームです。 残念ながら、このリポジトリのサポートに関する質問には対応することができません。 ドキュメントとは関係のない GitHub に関する問題が発生している場合は、GitHub サポートに直接お問い合わせください。 ドキュメント リポジトリで開かれたサポートを要求する問題や pull request には、GitHub サポートへのお問い合わせの方法についての情報が提供されており、その後閉じられロックされます。　

GitHub アカウントで問題が発生した場合は、サポートにお問い合わせください。

翻訳

この Web サイトは国際化されており、複数の言語でご利用になれます。 このリポジトリのソース コンテンツは英語で記述されています。 社内プロセスを通じて翻訳を自動化し、プロの翻訳者と協力して英語のコンテンツをローカライズしています。

翻訳エラーを発見された場合は、詳しい内容について Issue を提起してください。

現在、翻訳済みコンテンツの pull request は受け付けておりません。

サイト ポリシー

GitHub のサイト ポリシーも docs.github.com に公開されています。

サイト ポリシー セクションに入力ミスを見つけた場合は、pull request を開いて修正できます。 その他については、site-policy リポジトリの「コントリビューション」をご覧ください。