はじめに
先日、Railsガイドの表記誤りを見つけたので、初めて修正PRを送ってマージされました🎉
この記事では、その経験や実際に行った手順を共有したいと思います！😊
Railsガイド（日本語版）とは
『Railsガイド』は Ruby on Rails Guides に基づいた大型リファレンスガイドです。
Railsの各機能を体系的に学び、プロダクト開発の生産性を高めたいときに役立ちます。
参考：Railsガイドの公開リポジトリ READMEより
Railsの基本から応用まで体系的にまとめられており、Railsを学ぶ上で非常に有用なリソースです。
ActiveRecordやActionView、ルーティングなど、Railsの主要な機能について詳しく解説されており、開発中に何度も参照する必須のリファレンスとなっています📕
特徴としては、下記になります。
- 常に最新バージョンに対応（執筆時点では8.1対応）
- メソッドの使い方が羅列された「APIリファレンス」とは異なり、体系的な解説がまとめられている
- YassLab株式会社とコミュニティの有志によって翻訳・運営されています
表記誤りを見つけたきっかけ
Railsガイドを読んでいる際に、あるバリデーションの説明で
errorsメソッドは、すべてのエラーを含むActiveModel::Errorクラスのインスタンスを1つ返します。
と記載されていました。
「あれ？確かerrorsメソッドはActiveModel::Errorsクラスのインスタンスを返すはず...？」と思い、英語版のRailsガイドとRailsコンソールで確認したところ、やはりActiveModel::Errorsクラスのインスタンスを返すことがわかりました。
修正後
errorsメソッドは、すべてのエラーを含むActiveModel::Errorsクラスのインスタンスを1つ返します。
ActiveModel::Error→ActiveModel::Errorsに修正
class Report < ApplicationRecord
end
report = Report.new
report.errors
=> #<ActiveModel::Errors []>
report.errors.class
=> ActiveModel::Errors
修正PRを送るまでの手順
「表記ミスを見つけたんだけど、どうやって修正してもらえるんだろう？」と思いながら、READMEを見ていると書いてありました！
Railsガイドを読んで誤字・脱字・誤訳などを見かけましたら、下記の『ブラウザでRailsガイドの修正を提案する』に沿って Pull Request (プルリク) を送っていただけると嬉しいです 😌
もし原著 (英語版 Rails Guides) の間違いを見つけたら プルリクチャンス です! Railsガイドの『Railsのドキュメントに貢献する』を参考に
rails/rails にプルリクを送ってみましょう 🌐🤝
修正提案の手順も詳しく書かれており、オススメされていたブラウザ上だけで完結する方法で進めました！
手順1
- ブラウザ上でRailsガイドリポジトリの該当フォルダにアクセスし、この中から修正したいファイルを探す
手順2
- 画面右にある✎アイコン 「
Fork this project and edit this file」 をクリックする
手順3
- 中央の「
Fork this repository」をクリックする
手順4
- ブラウザ修正内容が入力できる状態となっているので修正内容を入力し、画面右上の「
Commit changes」をクリックする
手順5
- 「
commit message」を入力し、画面下部にある「Propose changes」をクリックする
手順6
- 内容を確認し、問題なければ「
Create pull request」をクリックする
手順7
- PRのタイトルと内容を入力し、「
Create pull request」をクリックする
手順8
- PRが作成されたことを確認し、あとはレビューとマージを待つ
手順9
- 1日も経たずして確認いただき、マージ🙆
手順10
- Railsガイドの該当ページにて修正が反映されていることを確認！
完了🎉
おわりに
ほんとに軽微な修正でしたが、初めてのPRがマージされて嬉しかったです😊
いつも一方的にお世話になっているRailsコミュニティに、少しでも貢献できたかなと思います！
最後まで読んでいただき、ありがとうございました🙌
参考資料