ハンドブックの技術的側面

Mon, 01 Jan 0001 00:00:00 +0000

ハンドブックの技術的側面 #

/content/docs/内を編集することで、ハンドブックの内容を更新することが出来ます

ハンドブックへの貢献

Mon, 01 Jan 0001 00:00:00 +0000

ハンドブックへの貢献 #

ハンドブックを改善するのには色々な方法があります。この記事では、その方法について解説します。GitやGitHubの用語については　GitとGitHubについてを参照してください。具体的にどのファイルを更新するべきなどかは、ハンドブックの技術的側面を参照してください。

Issue を立てる #

このハンドブックについて質問があったり、改善するべきことを見つけたときはIssuesを活用してください。このハンドブックのIssues を見て、同じ内容のIssueが立っていなければ、New issue ボタンをクリックして、新しい issue を立ててください。

質問に答える #

Issues に上がっている質問に答えることによっても、ハンドブックの品質向上に貢献することができます。

質問に答えるときは、ハンドブックのどこを根拠として回答しているかを明確にしてください。ハンドブックにすでに記載されている内容によって疑問が解決したらハンドブック issue を閉じてください。

反対に、もしハンドブックの記載の中に根拠を見つけられない場合、たとえ疑問が解決したとしてもハンドブックを改善する必要があります。この場合は issue は閉じないでください。

ブランチを切って Pull Request を送る #

Issue が立てられた改善点のうち、誤字脱字等の軽微な修正は Handbook Maintainer が修正して直接コミットしますが、大きな修正や内容の追加の場合、PRベースで更新を行います。

Issue が立っている改善点の中に、もし自分が改善できそうなものがあれば、新しいブランチを切って編集し、Pull Request を作成してください。この際、該当する issue を紐付けてください。変更を Handbook Maintainer が承認すれば、変更が main ブランチにマージされ、issue が閉じられます。