ドキュメントの修正から始めるAngularへの貢献
これはAngularアドベントカレンダー11日目の記事です。昨日は@sundamamiさんでした。
皆さんは angular.jp のドキュメントを修正したことはありますか？
実は軽微なミス（レイアウト崩れ、markdownのミスなど）の修正は、ブラウザだけで簡単に送ることができます。ここでは自分が実際に修正を行った手順を例に、軽微なミスを見つけてからドキュメントを修正する手順を紹介します。
軽微なミスを見つけてから修正する手順
テストユーティリティAPI • Angular 日本語版のページでミスを見つけて修正を行う、という想定で紹介します。
まずはドキュメントでミスを見つけたページの上部にある鉛筆✏️マークを押します。
鉛筆✏️マークを押下すると、該当のドキュメントが編集できる GitHub 上のEdit機能が開きます。
ここからドキュメントを修正したら、「Commit changes」を押します。
コミットメッセージ[1]を書いたら「Propose changes」を押します。そうすると、フォークされたリポジトリに新しいブランチが切られてコミットが積まれます。
フォークされたリポジトリのブランチからangular/angular-jaの main ブランチに対してPull Requestを作ります。
Pull Requestのdescriptionには修正した内容を簡単に記載します。
修正する内容は CONTRIBUTING.md に従っていることを確認する必要があります。ただ、今回想定しているような軽微な修正の場合、文章の内容自体を変えることは少ないため、神経質にチェックする項目はないと思います。
初回にGoogleのオープンソースプロジェクトのコントリビュートする場合は、Contributor License Agreement(CLA)に署名する必要があります。もし署名が不足している場合はCIが落ちるので、CIのリンクから署名をしたあとに、再度CIを実行してください。
作成した Pull Request のレビューが通ればマージされ、ドキュメントが修正されます。
ドキュメントを修正するデモ動画
Angular日本ユーザー会が主催するオンラインイベントである ng-japan OnAir では、実際にドキュメントを修正するデモの動画があります。合わせてご覧ください（下記の動画の 25:57 あたりから）。
軽微な修正だけでも貢献につながる
軽微な修正をしても意味があるのか？という疑問があるかもしれません。そういう方々へ向けて、 angular.jp を運営する lacolaco さんのコメントをお伝えします。
angular.jpの修正は簡単にできるので見つけたら修正しましょう
今回紹介したやり方を知っていれば、ドキュメントを直すハードルもグッと下がるのではないでしょうか。身近なところから Angular に貢献しましょう。
ありがとうございました。Angularアドベントカレンダー、明日は@http_kato83さんです。
-
コミットメッセージの形式はCONTRIBUTING.mdに明記されていないので、すでにあるコミットメッセージに合わせて書くと良いと思います。 ↩︎
Discussion