Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Railsガイドの「Rails をはじめよう」にある「8.4 コントローラを生成する」について #1550

Closed
Angy-h opened this issue Dec 9, 2023 · 54 comments

Comments

@Angy-h
Copy link

Angy-h commented Dec 9, 2023

Railsガイドを利用して、学習させていただいています。いつもありがとうございます。

フィードバック

Edid | Backのリンクを付けるための手順の記載がないようでした。
示されている成果物と同じ結果にならないようでしたので、ご報告させていただきます。

再現方法

RailガイドのRails をはじめようの8.4 コントローラを生成する」のパートの内容を手順通りに進めました。

期待する結果 実際の結果
スクリーンショット 2023-12-09 17 14 49 スクリーンショット 2023-12-09 17 17 03
@yasulab
Copy link
Member

yasulab commented Dec 10, 2023

@Angy-h ご報告ありがとうございます!スクリーンショットなどの画像系は更新し忘れがちで、今回の件も「実際の結果」が正しく、画像の方が古い状態のようですね 💦 cc/ @hachi8833

もしよければ画像と同じように、

  • Title: Rails is Awesome
  • Text: It really is.
  • Commenter: A fellow dev
  • ...

といった情報を入力した上で、該当部分の画像を差し替えるプルリクエストを送ってもらえると嬉しいです (>人< )💖

なお :octocat: rails/rails の方も同様に古いスクリーンショットを使っていることを確認できたため、 :octocat: rails/rails に(英語で)プルリクエストを送ってみるとマージされる可能性もありそう です! (≧∇≦)b✨

https://edgeguides.rubyonrails.org/getting_started.html#generating-a-controller

image

参考: Railsガイド - Railsのドキュメントに貢献する

@Angy-h
Copy link
Author

Angy-h commented Dec 10, 2023

@yasulab お送りしました報告をご確認いただきまして、また、ご返信くださり、誠にありがとうございます。
ご連絡いただいたように、情報を入力して画像を差し替えるプルリクエストをお送りするようにいたします。
しかしながら、私にとっては、今回が初めての報告で、プルリクエストも初めてのことになります。
リクエストの送り方の要領を得ずまた自信がないために、今回ご指導いただいたOSS GATEの方に改めてご相談しご助力をお願いして、その方法をご指導いただくことになるように思います。
時間がかかるかもしれませんが、必ずお送りするようにいたしますので、今しばしお時間をちょうだいできますようお願い申し上げます。
どうぞよろしくお願いしたします。

@hachi8833
Copy link
Collaborator

@Angy-h さん、フィードバックありがとうございます!

@hachi8833
Copy link
Collaborator

@Angy-h 念のためひとつ確認いただきたいのですが、このissueの冒頭に貼っていただいた「実際の画像」(図の右)は、以下のうちv6.0の手順に沿った場合の画像のようです。

私が最新のv7.1で再現したところ、以下の赤い囲みの部分はソースコードに含まれていませんでした。v6.1〜v7.1いずれも囲みの部分はソースコードに含まれていませんでした。

image

<!-- ガイドv6.0 -->
<p>
  <strong>Title:</strong>
  <%= @article.title %>
</p>

<p>
  <strong>Text:</strong>
  <%= @article.text %>
</p>
<!-- ガイドv6.1 以降-->
<h1><%= @article.title %></h1>

<p><%= @article.body %></p>

@Angy-h
Copy link
Author

Angy-h commented Dec 20, 2023

@hachi8833 お世話になります。
はい、おっしゃるとおりだと思います。私も間違いがあってはいけないと思い、もう一度、手順を再現し、8.4までの作業結果のスクリーンショットを撮り直しました。赤線で囲ったところが相違のあるところだと思います。
あと、細かいかもしれないですが、"Rails is Awesome!"のところがh1タグなので、pタグのIt really is.よりかなり大きい文字で表示されています。
current_image_withComments20231216

現況報告をさせていただきますと、ただ今、OSS GATEの作業用ログでご指導を受けてます。

@kou
Copy link

kou commented Dec 20, 2023

@Angy-h oss-gate/workshop#1745https://github.com/rails/rails にプルリクエストを送るまでのサポートをするよりもここでやった方が今後同じような流れになった人(日本語版のRailsガイドを修正しようと思ったけど英語版を修正した方がよさそう!となった人)の役に立ちそうなので、続きはここでやりませんか!?

@yasulab いいっすよね!?

@kou
Copy link

kou commented Dec 20, 2023

Railsガイド - Railsのドキュメントに貢献するによると英語版を修正する手順は以下の通り。

英語ドキュメントに貢献したい方は、Railsガイドの英語ソースファイルを変更してから、プルリクエストでmainブランチに変更の反映を依頼してください。 ドキュメント変更のプルリクエストでは、CIビルドの実行を避けるため、プルリクエストのタイトルに[ci skip]を含めてください。

タスクに分けるとこうですね。

  1. Railsガイドの英語ソースファイルを変更する
  2. プルリクエストでmainブランチに変更の反映を依頼する
  3. ドキュメント変更のプルリクエストでは、CIビルドの実行を避けるため、プルリクエストのタイトルに[ci skip]を含める

#1550 (comment) によるとプルリクエストを送ったことはないということなので、1.のやり方をブレイクダウンしないとできない。

では、GitHubの公式ドキュメント https://docs.github.com/ja/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request をベースにやってみましょうか!

上から読んで順番にやりましょう。まずはすごく先頭らへんにある↓の部分までやってみてください。(今回は「リポジトリへの書き込みアクセス許可がない場合」です。 https://github.com/rails/rails への書き込みアクセス許可がないからです。)

pull request 用に新しいブランチを作成する必要があり、リポジトリへの書き込みアクセス許可がない場合は、まずリポジトリをフォークできます。 詳細については、「フォークからプルリクエストを作成する」および「フォークについて」を参照してください。

@hachi8833
Copy link
Collaborator

@kouさん、サジェスチョンありがとうございます!🙇
@Angy-h 私もサポートいたします(rails/railsへのプルリクが手に余るようでしたらこちらで引き受けますのでお気軽にお知らせください)。

@Angy-h
Copy link
Author

Angy-h commented Dec 21, 2023

@kouさん、お疲れ様です。ご指導ありがとうございます。
時間がかかりましたが、 https://github.com/rails/rails のフォークができました(と思います)。
https://github.com/Angy-h/rails_en_forked
また、「フォークしたリポジトリのクローン」と「アップストリームのリポジトリと同期させる方法」も行い、下記のようになりました。
スクリーンショット 2023-12-21 20 11 44
私のパソコン内には、rails_en_forkedのフォルダが作成され、中にはたくさんのフォルダができています。
こちらでよろしいでしょうか。
よろしくお願いいたします。

@kou
Copy link

kou commented Dec 22, 2023

@Angy-h そうっすね。大丈夫そうです。

では、そのパソコン内のrails_en_forkedフォルダーに移動して「トピックブランチ」を作成してそこに必要な変更をコミットして https://github.com/Angy-h/rails_en_forked にプッシュしてください。

↑はGitを使える前提の説明なんですが、Gitを使った経験はありますか?ないならそこらへんから説明するので言ってください。

@yasulab
Copy link
Member

yasulab commented Dec 22, 2023

続きはここでやりませんか!?
@yasulab いいっすよね!?

もちろんです! 🆗✨ぜひぜひ...!! 😆👌

(リアクションでも意思表示していましたが改めてコメントでも! 🙏✨ OSS Gateの活動例の1つとしても繋がったら幸いです 😌💖)

@Angy-h
Copy link
Author

Angy-h commented Dec 22, 2023

@kouさん、お世話になります。ご指南ありがとうございます。
初歩的なことで申し訳ございませんが、いくつか質問させてください。

1.「トピックブランチ」を作成する、について
1-1 ターミナルで、次のコマンドを実行するとよいでしょうか?
git checkout -b getting_started_8.4_image
1-2 "getting_started_8.4_image"の部分は、適切なものがあればお教えいただければと思います(workとかの方が良いのでしょうか?GitHubの本ではそんな言葉を使っていました。)。

2.必要な変更を行う、については、次の内容でよろしいでしょうか?
2-1 作成したトピックブランチで、rails_en_forked/guides/sourceにあるgetting_started.mdを修正する(VSCordでgetting_started.mdを開く)。
2-2 getting_started.mdの中の、1579行の次の記述のうち、article_with_comments.pngを撮り直したイメージのファイル名(new_article_with_comments.png)に修正する。
![Article with Comments](images/getting_started/article_with_comments.png)
こちらに修正
![Article with Comments](images/getting_started/new_article_with_comments.png)

2-3 rails_en_forked/guides/images/getting_startedフォルダの中に、撮り直したイメージnew_article_with_comments.pngを保存する。

確認した事
*PC内のrails_en_forkedフォルダに移動して、cloneしたリポジトリのブランチを確認しました。
スクリーンショット 2023-12-22 20 34 30

*フォルダ内には、rails_en_forked/guides/sourceの中に、索引らしき名称がついているファイルがあることを確認しました。
スクリーンショット 2023-12-22 21 45 13
*日本語版の「Rails をはじめよう」に相当する、英語版のRAILS GUIDESのファイルは、getting_started.mdかな?と思いました。

長々といろいろすみません。
作業内容を考えてみたのですが、これで合っているのか心配ですので、教えていただければ幸いです。
どうぞよろしくお願いいたします。

@Angy-h
Copy link
Author

Angy-h commented Dec 22, 2023

@kouさん、サジェスチョンありがとうございます!🙇 @Angy-h 私もサポートいたします(rails/railsへのプルリクが手に余るようでしたらこちらで引き受けますのでお気軽にお知らせください)。

@hachi8833 さん、お心遣いありがとうございます。私が要領を得ないため時間がかかってしまい、ご心配をおかけしております。初心者の私にとっては、なかなかハードルの高い工程ですが、kouさんのご指導の下、できるところまで頑張ってみたいと思います。
今後ともどうぞよろしくお願い申し上げます。

@kou
Copy link

kou commented Dec 27, 2023

@Angy-h

1-1 ターミナルで、次のコマンドを実行するとよいでしょうか?

git checkout -b getting_started_8.4_image

そうっすね。それでもOKです。
ただ、最近はgit checkout -bではなくgit switch -cの方が推奨なのでそっちで覚えたほうがいいとは思います。

1-2 "getting_started_8.4_image"の部分は、適切なものがあればお教えいただければと思います(workとかの方が良いのでしょうか?GitHubの本ではそんな言葉を使っていました。)。

私は何をするブランチかを端的に表す名前を使っています。たとえば、getting-started-update-screenshotとかです。

workとかどんなときでも使える名前は私は好きじゃありません。後からどんなブランチかわかりにくいからです。

私は使いませんが、issue-1550とか対応するissueのIDを使う流儀の人もいます。

いろいろアプローチはありますが、何に注目したブランチかがわかる名前ならなんでもいいです。なので、"getting_started_8.4_image"も悪くないです。

2.必要な変更を行う、については、次の内容でよろしいでしょうか?
2-1 作成したトピックブランチで、rails_en_forked/guides/sourceにあるgetting_started.mdを修正する(VSCordでgetting_started.mdを開く)。
2-2 getting_started.mdの中の、1579行の次の記述のうち、article_with_comments.pngを撮り直したイメージのファイル名(new_article_with_comments.png)に修正する。
![Article with Comments](images/getting_started/article_with_comments.png)
こちらに修正
![Article with Comments](images/getting_started/new_article_with_comments.png)

new_...を作るのではなくて既存の画像を上書きしてください。
既存の画像が古くて更新したいんですよね?

2-3 rails_en_forked/guides/images/getting_startedフォルダの中に、撮り直したイメージnew_article_with_comments.pngを保存する。

これも既存のファイルを更新してください。

確認した事
*PC内のrails_en_forkedフォルダに移動して、cloneしたリポジトリのブランチを確認しました。
スクリーンショット 2023-12-22 20 34 30

*フォルダ内には、rails_en_forked/guides/sourceの中に、索引らしき名称がついているファイルがあることを確認しました。
スクリーンショット 2023-12-22 21 45 13
*日本語版の「Rails をはじめよう」に相当する、英語版のRAILS GUIDESのファイルは、getting_started.mdかな?と思いました。

あっていると思うのですが、より確実に確認する場合は、リポジトリー内にあるファイルからHTMLを生成してみて期待した結果になっているかを確認するのがいいと思います。

https://railsguides.jp/contributing_to_ruby_on_rails.html#rails%E3%81%AE%E3%83%89%E3%82%AD%E3%83%A5%E3%83%A1%E3%83%B3%E3%83%88%E3%81%AB%E8%B2%A2%E7%8C%AE%E3%81%99%E3%82%8B 関連のドキュメントでHTMLを生成する方法が説明されていないか確認してもらえますか?説明されていなかったらここにいる誰かが助けてくれるはず!

長々といろいろすみません。 作業内容を考えてみたのですが、これで合っているのか心配ですので、教えていただければ幸いです。 どうぞよろしくお願いいたします。

はい、一緒に問題を解決していきましょう!

@Angy-h
Copy link
Author

Angy-h commented Dec 30, 2023

お世話になっております。
次の作業を行いました。
6までを行いましたが、ドキュメントのHTMLを生成する、というところでうまくできませんでした。
お手数をおかけして恐縮なのですが、ドキュメントのHTMLを生成するための手順をご教示いただけますでしょうか。

1.rails_en_forkedフォルダーに移動して「トピックブランチ」:getting-started-update-screenshotを作成しました。
2.更新しようとしているファイルがarticle_with_comments.pngであることを確認するために、ドキュメントのHTMLを生成する方法を確認しました。
7 HTMLガイド

3.そのガイドの中で、最新のBundlerをインストールするようにとありましたので、インストールしました。
スクリーンショット 2023-12-30 8 57 20

4.その次に、そのガイドの中にあります、$ bundle exec rake guides:generateや$ bundle exec rake guides:generate:htmlを行ったところ、bundle installを先に行うようにというメッセージが出てきました。
スクリーンショット 2023-12-30 8 49 52

5.そのため、bundle installを行ったところ、インストールが始まり、下記のような結果になりました。
スクリーンショット 2023-12-30 8 51 52
・・・
スクリーンショット 2023-12-30 8 51 52

6.その後、$ bundle exec rake guides:generateや$ bundle exec rake guides:generate:htmlを行いましたが、次のような結果となりました。
ガイドには、「生成されたHTMLファイルは、./outputディレクトリに配置されます。」とありますが、./outputディレクトリは作成されていないように思いました。
スクリーンショット 2023-12-30 9 00 30

@kou
Copy link

kou commented Dec 30, 2023

実行結果を共有するのはすごくいい進め方なので継続してください!
共有の仕方ですが、今回のようにテキストデータのみのときはスクリーンショットよりも

```console
$ bundle exec rake ...
...
```

とかしてそのまま書いてもらった方が助かります。テキストだけページ内検索をできますが、スクリーンショットだとできないからです。

ページのレンダリング結果とかテキスト以外の情報も含むときはスクリーンショットの方がいいです!

https://railsguides.jp/ruby_on_rails_guides_guidelines.html#html%E3%82%AC%E3%82%A4%E3%83%89

には

すべてのガイドを生成するには、cdコマンドでguidesディレクトリに移動し、bundle installを実行してから以下のいずれかを実行します。

とありますが、「cdコマンドでguidesディレクトリに移動し」をやっていないように見えます。
これをやってからbundle exec rake guides:generateしてみてください。

「bundle installを実行してから」の部分も見逃していたようですし、実行しなければいけないコマンドは本文で説明するよりも$ bundle exec rake guides:generateの部分のようにコマンドを実行するような表示になっていたほうが見逃しにくくなるのかもしれません。

これは、別に見逃したことが悪いと言っているわけではなくて、「初めての人が普通にやってみたら見逃したという事実がある」と言っているに過ぎません。そして、このドキュメントは「初めての人が普通にやったら普通にできる」ことを意図した文書のはずなので、既存のドキュメントに改良する余地がありそうということがわかったということです。

このスクリーンショットの更新が一段落したら、このあたりの書き方の改良を提案する、ということにもチャレンジしてもいいかもしれません。

@Angy-h
Copy link
Author

Angy-h commented Jan 3, 2024

お世話になります!
早々にご返信くださり誠にありがとうございます。
本年もどうぞよろしくお願い申し上げます。

8までの作業を行いました。
いただいたご指示を続けたいのですが、その次の作業は次の内容でよろしいでしょうか。
ご教示くださいますようお願い申し上げます。

では、そのパソコン内のrails_en_forkedフォルダーに移動して「トピックブランチ」を作成してそこに必要な変更をコミットして https://github.com/Angy-h/rails_en_forked にプッシュしてください。

ターミナルで下記を実行する。

git commit -m "Update article_with_comments.png"
git push

これは、getting-started-update-screenshotにいる状態で実行するということでよろしいでしょうか?

行った作業
1.今いる場所の確認

guides % git branch
  main
*  getting-started-update-screenshot

2.最新のBunderが使用されていることを確認

rails_en_forked % bundler -v             
Bundler version 2.5.3

3.cdコマンドでguidesディレクトリに移動し、bundle installを実行

guides % bundle install
Bundle complete! 80 Gemfile dependencies, 216 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.

4.下記を実行
bundle exec rake guides:generate

5.HTMLが作成されたので(やったー!)、getting_started.htmlページでイメージのファイル名を確認
スクリーンショット 2024-01-03 10 16 56

6.guides/assets/images/getting_startedのフォルダへ作成した画像をarticle_with_comments.pngという名前で保存(差し替え)
7.再度bundle exec rake guides:generateを実行して、差し替え後の状態を確認
スクリーンショット 2024-01-03 10 52 47

*ネット上の該当ページと比較
スクリーンショット 2024-01-03 10 53 35

8.git diffで確認
画像を差し替えただけという結果になっていますでしょうか?

guides % git diff
diff --git a/Gemfile.lock b/Gemfile.lock
index 082c2e8bd4..0833296f22 100644
--- a/Gemfile.lock
+++ b/Gemfile.lock
@@ -651,4 +651,4 @@ DEPENDENCIES
   websocket-client-simple!
 
 BUNDLED WITH
-   2.3.22
+   2.5.3
diff --git a/guides/assets/images/getting_started/article_with_comments.png b/guides/assets/images/getting_started/article_with_comments.png
index 3f16f3b280..50943ac95d 100644
Binary files a/guides/assets/images/getting_started/article_with_comments.png and b/guides/assets/images/getting_started/article_with_comments.png differ

@kou
Copy link

kou commented Jan 4, 2024

今年もよろしくお願いします!

Gemfile.lockの変更は不要なので、画像の変更だけをgit addしてからgit commitしてください。たぶん、こんな感じになると思います。

guides$ git add assets/images/getting_started/article_with_comments.png
guides$ git commit -m "Update screenshot in Getting Started"
guides$ git push origin  getting-started-update-screenshot

@Angy-h
Copy link
Author

Angy-h commented Jan 6, 2024

お世話になります。
いつもご指導ありがとうございます!

早速、下記コマンドを実行しました。

guides$ git add assets/images/getting_started/article_with_comments.png
guides$ git commit -m "Update screenshot in Getting Started"
guides$ git push origin  getting-started-update-screenshot

2つ目までは進みましたが、3つ目を実行すると、下記のエラーが出てきました。

guides % git push origin  getting-started-update-screenshot
error: src refspec getting-started-update-screenshot does not match any
error: failed to push some refs to 'https://github.com/Angy-h/rails_en_forked.git'

ChatGPTに聞いてみると、git branch -a コマンドを使用して、ローカルとリモートのすべてのブランチを確認するということでしたので、それを実行しました。
getting-started-update-screenshot ブランチはローカルに存在していることを確認しました。

guides % git branch -a
  main
*  getting-started-update-screenshot
  remotes/origin/HEAD -> origin/main
  remotes/origin/main

次に、リモートの origin に getting-started-update-screenshot ブランチが存在するかどうかも確認する必要がある、ということでしたので、git ls-remote --heads originを実行しました。
下記の結果となりました。

guides % git ls-remote --heads origin

6c0f897293f6b0dac2f3a60f454b8bbda0bcaf96	refs/heads/main

そうすると、ChatGPTは、この出力から、getting-started-update-screenshot ブランチがリモートの origin には存在しない、ということなので、下記を実行してみてください、ということでした。

git push -u origin getting-started-update-screenshot

3つ目のコマンドguides$ git push origin getting-started-update-screenshotと少し違うようなのですが、git push -u origin getting-started-update-screenshotを実行してもよいのでしょうか?
ご教示くださいますようお願い申し上げます。

なんだか一向に前に進まなくて大変恐縮です。
どうぞよろしくお願い申し上げます。

@kou
Copy link

kou commented Jan 6, 2024

あれ、-uをつけないとダメなんだったかしら。
つけても問題ない(-uをつけると後でgit pullするときに便利になる)のでやってみてください。

なんだか一向に前に進まなくて大変恐縮です。

最初はみんなそんなものなのでくじけずに一歩ずつ進んでいきましょう!

@Angy-h
Copy link
Author

Angy-h commented Jan 6, 2024

お世話になります。
早々にご返信くださりありがとうございます!

git push -u origin getting-started-update-screenshotを実行したところ、またリモートにプッシュできないエラーが出ました。
ChatGPTによれば、「Gemfile.lockの変更をステージングする必要があり、次のコマンドで変更をステージングし、コミットしてからプッシュできるようになるはずです。」とのことでした。
Gemfile.lockの変更は不要とおっしゃっていただきましたが、下記のコマンドを実行しても良いのでしょうか?
ご教示くださいますようお願い申し上げます。

git add ../Gemfile.lock
git commit -m "Update Gemfile.lock"
git push -u origin getting-started-update-screenshot

ターミナルの実行結果

git branch
  main
*  getting-started-update-screenshot
guides % git add assets/images/getting_started/article_with_comments.png
guides % git commit -m "Update screenshot in Getting Started"
On branch  getting-started-update-screenshot
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   ../Gemfile.lock

no changes added to commit (use "git add" and/or "git commit -a")
guides % git push -u origin getting-started-update-screenshot
error: src refspec getting-started-update-screenshot does not match any
error: failed to push some refs to 'https://github.com/Angy-h/rails_en_forked.git'

@kou
Copy link

kou commented Jan 6, 2024

ChatGPTによれば、「Gemfile.lockの変更をステージングする必要があり、次のコマンドで変更をステージングし、コミットしてからプッシュできるようになるはずです。」とのことでした。

嘘です。ChatGPTにだまされないでください!

git statusはどうなっていますか?

@kou
Copy link

kou commented Jan 6, 2024

あと、git branch -aはどうなっていますか?

@Angy-h
Copy link
Author

Angy-h commented Jan 6, 2024

ご返信ありがとうございます。
git statusは、次のようになっています。

guides % git status
On branch  getting-started-update-screenshot
Changes not staged for commit:
  (use "git add <file>..." to update what will be committed)
  (use "git restore <file>..." to discard changes in working directory)
	modified:   ../Gemfile.lock

no changes added to commit (use "git add" and/or "git commit -a")

git branch -aは、次のとおりです。

guides % git branch -a
  main
*  getting-started-update-screenshot
  remotes/origin/HEAD -> origin/main
  remotes/origin/main

@kou
Copy link

kou commented Jan 6, 2024

うーん、ブランチ名の前に全角スペースが入っている気がしますね。。。
以下をコピペして全角スペースを抜いてからgit pushしてみてください。

$ git branch -m ' getting-started-update-screenshot' getting-started-update-screenshot
$ git push origin getting-started-update-screenshot

@Angy-h
Copy link
Author

Angy-h commented Jan 6, 2024

大変失礼いたしました。
お手数おかけして申し訳ございません。
無事pushすることができました(と思います)。
結果をご報告させていただきます。

guides % git push origin getting-started-update-screenshot
Username for 'https://github.com': Angy-h
Password for 'https://Angy-h@github.com': 
Enumerating objects: 13, done.
Counting objects: 100% (13/13), done.
Delta compression using up to 8 threads
Compressing objects: 100% (7/7), done.
Writing objects: 100% (7/7), 45.29 KiB | 22.65 MiB/s, done.
Total 7 (delta 4), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (4/4), completed with 4 local objects.
remote: 
remote: Create a pull request for 'getting-started-update-screenshot' on GitHub by visiting:
remote:      https://github.com/Angy-h/rails_en_forked/pull/new/getting-started-update-screenshot
remote: 
To https://github.com/Angy-h/rails_en_forked.git
 * [new branch]            getting-started-update-screenshot -> getting-started-update-screenshot

フォークしたリモートリポジトリ(?)の方も次のようになっていました!
https://github.com/Angy-h/rails_en_forked
スクリーンショット 2024-01-07 8 24 17

次は、プルリクエストの作成に進むとよろしいでしょうか?
ご教示くださいますようお願い申し上げます。

@kou
Copy link

kou commented Jan 7, 2024

そうっすね。

#1550 (comment) で確認した通り、プルリクエストのタイトルには[ci skip]を入れる必要があることを忘れないようにしないといけません。

あと、プルリクエストを作るときはタイトルだけではなく本文も書く必要があるので、まずは、タイトルと本文の内容をここで考えて、できあがってからプルリクエストを作りましょう。

https://raw.githubusercontent.com/rails/rails/main/.github/pull_request_template.md にプルリクエストの本文のテンプレートがあるので、これをベースに作ってみてください。どう書けばいいかわからないところはどうしてどう書けばいいかわからなかったかを教えてください。このテンプレートの改善が必要かもしれません。

@kou
Copy link

kou commented Jan 7, 2024

https://github.com/rails/rails/commits/main/guides がコミット履歴ですが、対応するプルリクエストへのリンクがあるものもあるので、そういう既存のプルリクエストでの書き方も参考にしてみてください。

@Angy-h
Copy link
Author

Angy-h commented Jan 8, 2024

いつもご指導ありがとうございます!
そして、参照すべき資料もお示しいただきましてありがとうございます。
タイトルと本文の内容を考えてみました。
ご検討、ご教授くださいますよう、お願い申し上げます。

作成にあたっては、次の点をご報告と質問をさせていただきます。

  1. ### Additional informationは、削除しました。
  2. 本文については、「私は初心者で〜」みたいな自己紹介は書かなくてもよいものか、わかりませんでしたが、他の人のプルリクエストを見るとそんなことは書いていらっしゃらないので、不要なのだと思いました。ですが、みなさんすでにコミュニケーションを取れている方ばかりなので、そのようなことは書いていないのかな?とも思っています。
  3. Checklistは、チェックを付けてよいものか、該当しない項目はチェックを付けないまま送ってもよいもののか、よく分かりませんでした。
    3-1 Checklistの2つ目:Commit messageは、ターミナルで実行したコマンド「guides$ git commit -m "Update screenshot in Getting Started"」の中の、"Update screenshot in Getting Started"を指すのでしょうか?とすると、そんなにdetailedではないかもしれないですけど、チェックは付けて良いでしょうか?
    3-2 "Commit message has a detailed description of what changed and why."と"If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]"が異なる点を言っているように思われましたので、チェックをつけてよいかどうか、悩みます。
    3-3 Checklistの3つ目:今回についてのTestは、画像差し替え後のページ確認のスクリーンショットを添付することになるのでしょうか?それとも特にそのようなものは添付せず、このChecklistは、空欄でもよいのでしょうか?
    3-4 Checklistの4つ目:今回については、CHANGELOG filesはない、ということでチェックマークなし、ということでよろしいでしょうか?

タイトルと本文の下書きは、次のとおりです。

タイトル:Update the screenshot in the section 8.4 of Getting Started with Rails [ci skip]
本文:

Motivation / Background

I've been following the RAILS GUIDES available at https://railsguides.jp/getting_started.html in Japanese (https://edgeguides.rubyonrails.org/getting_started.html in English). Upon reaching the end of section 8.4, I noticed several differences between the output displayed in the guide's screenshot and what appeared on my computer:

  • The positioning of "Edit/Back" differs.
  • While the guide provides an explanation for "Destroy," it doesn't offer one for "Back."
  • My output lacked the "Title:" and "Text:" elements.
  • The text "Rails is Awesome!" appeared larger due to the h1 tag.

Detail

This Pull Request changes article_with_comments.png in /guides/assets/images/getting_started.

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

@kou
Copy link

kou commented Jan 10, 2024

1. `### Additional information`は、削除しました。

そうっすね。
今回はなくてもよさそうですね。

2. 本文については、「私は初心者で〜」みたいな自己紹介は書かなくてもよいものか、わかりませんでしたが、他の人のプルリクエストを見るとそんなことは書いていらっしゃらないので、不要なのだと思いました。ですが、みなさんすでにコミュニケーションを取れている方ばかりなので、そのようなことは書いていないのかな?とも思っています。

そうですね。いらないです。
それがissue/pull requestに関わるなら入れるべきですが、そうでないなら入れなくていいです。たとえば、初心者向けのドキュメント通りに初心者がやってみたらうまくいかなかった、とかなら報告者が初心者かどうかが重要なので入れた方がいいです。

3. Checklistは、チェックを付けてよいものか、該当しない項目はチェックを付けないまま送ってもよいもののか、よく分かりませんでした。

チェックをつけていいです。というか、つけます。
該当しない項目はチェックをつけないでいいです。

   3-1 Checklistの2つ目:Commit messageは、ターミナルで実行したコマンド「guides$ git commit -m "Update screenshot in Getting Started"」の中の、"Update screenshot in Getting Started"を指すのでしょうか?とすると、そんなにdetailedではないかもしれないですけど、チェックは付けて良いでしょうか?

Gitのコミットメッセージでは3行目以降に書かれるやつの部分になります。

@yasulab @hachi8833 Gitのコミットメッセージのお作法(1行目はタイトルで2行目は空行にしてとか)をいい感じに説明したWebページを知っていたら共有してもらえますか?

今回の場合だと「今のスクリーンショットは古いRailsで動かしたときに撮ったもののようなのでRails Xだと違う結果になる。だから、Rails Xでスクリーンショットを撮り直したよ。」くらい書くのがdetailedな話になります。今回は「Getting Startedのスクリーンショットを更新したよ」しか書いていないのでdetailedではないですね。たとえば、今回はRailsのどのバージョンかが大事なポイントになると思いますが、そういうのが入っていません。

   3-2 "Commit message has a detailed description of what changed and why."と"If this PR fixes a related issue include it in the commit message. Ex: `[Fix #issue-number]`"が異なる点を言っているように思われましたので、チェックをつけてよいかどうか、悩みます。

異なることを言っているわけではないですね。大事なところはwhat changedとwhyのdetailed descriptionがあるかないかです。最初の文はコミットメッセージにある?ことに注目していて、次の文はコミットメッセージにないなら関連issueには書いてあるか?に注目しています。どちらも、 what changedとwhyのdetailed descriptionがあることを気にしています。

今回の場合、detailedではないですがwhatは入っている(スクリーンショットを更新した)んですが、whyはまったく入っていないのでチェックはつきません。なので、チェックをつけられるようなコミットメッセージにしないといけません。

   3-3 Checklistの3つ目:今回についてのTestは、画像差し替え後のページ確認のスクリーンショットを添付することになるのでしょうか?それとも特にそのようなものは添付せず、このChecklistは、空欄でもよいのでしょうか?

これは実装に関する変更のことなはずなのでチェック無しでいいです。

   3-4 Checklistの4つ目:今回については、CHANGELOG filesはない、ということでチェックマークなし、ということでよろしいでしょうか?

documentation changesになるのでCHANGELOGは更新しません。よってチェック無しでいいです。

タイトルと本文の下書きは、次のとおりです。

コミットメッセージをdetaild descriptionにして(what changedとwhyは必ず入れる)、その情報も追加したら大丈夫な気がします!

コミット済みのコミットのメッセージはgit commit --amendでできるはずです。

@yasulab @hachi8833 git commit --amendのいい感じの説明のページがあったら共有してください!

@hachi8833
Copy link
Collaborator

@kou お疲れさまです🙏!こちらでも取り急ぎ見繕ってみました:

コミットメッセージのお作法:

git commit --amendについて

@yasulab
Copy link
Member

yasulab commented Jan 10, 2024

書こうとしたら hachi8833 さんが書いてくれた...!! ありがとうございます!! 🙏 ✨

@kou
Copy link

kou commented Jan 10, 2024

あざっす!

@Angy-h
Copy link
Author

Angy-h commented Jan 11, 2024

皆さま、ご指導ありがとうございます!
そして、ご回答と次なるステップをお示しいただきありがとうございます!

コミットメッセージを修正する内容を考えました。
次のような内容でよろしいでしょうか?

[docs] Update Screenshot in "Getting Started with Rails"

Replace the existing screenshot with the output produced in Rails 7. The current screenshot seems to be captured in a previous version.

コミットメッセージの修正git --amendについて、質問させてください。
このコマンドですが、お示しいただいたページでは、Gitでリモートにpush済みのコミットをamendした時の対応方法、が説明されていました。
現時点では、リモートにpushしたように思いますので、git --amendをすると、上記対応が必要になるのかな?と思いました。
このままgit --amendを実行してもよろいいでしょうか?
それとも他にコミットメッセージを修正する方法があるのでしょうか?

タイトルと本文の下書きも修正しました。

  • rails/rubyのバージョンを追記
  • Motivation / Backgroundに既存のスクリーンショットをアップデートしたい旨を追加
  • チェックリスト2つ目のチェックを追加

タイトル:Update the screenshot in the section 8.4 of Getting Started with Rails [ci skip]
本文:

Motivation / Background

I've been following the RAILS GUIDES available at https://railsguides.jp/getting_started.html in Japanese (https://edgeguides.rubyonrails.org/getting_started.html in English). Upon reaching the end of section 8.4, I noticed several differences between the output displayed in the guide's screenshot and what appeared on my computer (rails version: Rails 7.1.2, ruby version: ruby 3.2.2):

  • The positioning of "Edit/Back" differs.
  • While the guide provides an explanation for "Destroy," it doesn't offer one for "Back."
  • My output lacked the "Title:" and "Text:" elements.
  • The text "Rails is Awesome!" appeared larger due to the h1 tag.

I would like to update the existing screenshot.

Detail

This Pull Request changes article_with_comments.png in /guides/assets/images/getting_started.

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

@yasulab
Copy link
Member

yasulab commented Jan 11, 2024

@Angy-h コミットメッセージ良さそうです!😆👌✨ 個人的な所感としては Description が比較的重要かなと思うので、自分の場合は Description を気にすることが多いですね 👀 ✅ で、以下の部分についてですが、

I've been following the RAILS GUIDES available at https://railsguides.jp/getting_started.html in Japanese (https://edgeguides.rubyonrails.org/getting_started.html in English).

自分なら、議論の的を絞るために Translation 関連の話はせず、より簡潔に以下のように書きますね! (確認する工程で英語版でも確かめていただいているかなと思うので)

- I've been following the RAILS GUIDES available at https://railsguides.jp/getting_started.html in Japanese (https://edgeguides.rubyonrails.org/getting_started.html in English). Upon reaching ...
+ I've been following the [getting started guide](https://edgeguides.rubyonrails.org/getting_started.html). Upon reaching ...

Railsガイド運営者視点では Japanese に触れていただけると存在感が高まって嬉しい限りですが、一方で PR の Description に Japanese/English の話を混ぜ込むと、Review する人から見て「それ Japanese だからでは? English なら大丈夫では?」と返されてマージされない可能性もありそうです。なので(もちろん英語版でも事前に確認した上で)上記のように的を絞った文にしておくと、不要なリスクを負わずに済みそうかなと思いました! (๑•̀ㅂ•́)و✨

ご参考になれば幸いです...!! (>人< )✨

@Angy-h
Copy link
Author

Angy-h commented Jan 12, 2024

@yasulabさん、アドバイスありがとうございます。
マージされないリスクを考慮して、それを避ける配慮をしなければいけないこと、理解いたしました!

タイトルと本文の下書きを次のように修正いたします。

  • rails/rubyのバージョンを追記
  • Motivation / Backgroundに既存のスクリーンショットをアップデートしたい旨を追加
  • チェックリスト2つ目のチェックを追加
  • ### Motivation / Background1行目を端的な文章に修正

Motivation / Background

I've been following the getting started guide. Upon reaching the end of section 8.4, I noticed several differences between the output displayed in the guide's screenshot and what appeared on my computer (rails version: Rails 7.1.2, ruby version: ruby 3.2.2):

  • The positioning of "Edit/Back" differs.
  • While the guide provides an explanation for "Destroy," it doesn't offer one for "Back."
  • My output lacked the "Title:" and "Text:" elements.
  • The text "Rails is Awesome!" appeared larger due to the h1 tag.

I would like to update the existing screenshot.

Detail

This Pull Request changes article_with_comments.png in /guides/assets/images/getting_started.

Checklist

Before submitting the PR make sure the following are checked:

  • This Pull Request is related to one change. Changes that are unrelated should be opened in separate PRs.
  • Commit message has a detailed description of what changed and why. If this PR fixes a related issue include it in the commit message. Ex: [Fix #issue-number]
  • Tests are added or updated if you fix a bug or add a feature.
  • CHANGELOG files are updated for the changed libraries if there is a behavior change or additional feature. Minor bug fixes and documentation changes should not be included.

@yasulab
Copy link
Member

yasulab commented Jan 12, 2024

良さそうです...!! (๑•̀ㅂ•́)و✨

準備できたらPR送ってみても良いかもですね 😆👌✨

@Angy-h
Copy link
Author

Angy-h commented Jan 12, 2024

ありがとうございます!

@kou
Copy link

kou commented Jan 12, 2024

現時点では、リモートにpushしたように思いますので、git --amendをすると、上記対応が必要になるのかな?と思いました。

たしかにgit pushするとそういうエラーになるはずなんですが、対処方法は違います。今回の場合は既存のコミットを上書きしようとしているので、git push --force-with-lease origin getting-started-update-screenshotですでにpush済みのコミットを上書きでいいです。

このままgit --amendを実行してもよろしいでしょうか?

いいです。

それとも他にコミットメッセージを修正する方法があるのでしょうか?

ないです!

pushしたらpull requestにしちゃいましょうか!

@Angy-h
Copy link
Author

Angy-h commented Jan 14, 2024

いつもお世話になっております。
ご指導、本当にありがとうございます。

コミットメッセージの修正の方、実行いたしました。

git --amend
git push --force-with-lease origin getting-started-update-screenshot

エラーは出ていないので、できているように思います。

rails_en_forked % git log
commit ab88c7059166edcf54c85befc14f144b32c2af58 (HEAD -> getting-started-update-screenshot)
Author: Annaheim.h@gmail.com <Anna Hiragi>
Date:   Sat Jan 6 09:14:22 2024 +0900

    [docs] Update Screenshot in "Getting Started with Rails"
    
    Replace the existing screenshot with the output produced in Rails 7. The current screenshot seems to be captured in a previous version.

commit 6c0f897293f6b0dac2f3a60f454b8bbda0bcaf96 (origin/main, origin/HEAD, main)
Merge: bf725a7876 f68727dcd0
Author: Jean Boussier <jean.boussier@gmail.com>
Date:   Thu Dec 21 10:53:33 2023 +0100

以下、続く
rails_en_forked % git push --force-with-lease origin getting-started-update-screenshot
Enumerating objects: 13, done.
Counting objects: 100% (13/13), done.
Delta compression using up to 8 threads
Compressing objects: 100% (7/7), done.
Writing objects: 100% (7/7), 45.39 KiB | 22.70 MiB/s, done.
Total 7 (delta 4), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (4/4), completed with 4 local objects.
To https://github.com/Angy-h/rails_en_forked.git
 + fb3ad909b5...ab88c70591 getting-started-update-screenshot -> getting-started-update-screenshot (forced update)

プルリクエストの方、作成してみました。
現在、次のようになっています。
こちらの内容で、「Create pull request」をクリックしても良いでしょうか?
スクリーンショット 2024-01-14 9 03 39

下記のドキュメントで説明されている黄色のバナー(Compare & pull request)が表示されていませんでした。
(つい先日見た時は表示されていましたのに。。。)
プルリクエストの作成

下記のページを参照して作成しました。
https://note.com/llminatoll/n/n03bf5aac004b

@kou
Copy link

kou commented Jan 14, 2024

コミットメッセージは80文字くらいで折り返したほうがいいです。なので、

Replace the existing screenshot with the output produced in Rails 7. The current screenshot seems to be captured in a previous version.

Replace the existing screenshot with the output produced in Rails 7. The current screenshot
seems to be captured in a previous version.

とかの方がベターです。

git commit --amendで ↑を直したらその手順でプルリクエストを作ってください。

ブランチが作られた直後なら黄色のバナーが出るんですが、しばらくするとでなくなるんです。

@Angy-h
Copy link
Author

Angy-h commented Jan 15, 2024

お世話になっております。
いつもご教授くださりありがとうございます。

コミットメッセージの修正の方、実行いたしました。
現在、次のようになっています。

rails_en_forked % git log
commit bd934475b9a0b74cf36171be26913cde70cf8f28 (HEAD -> getting-started-update-screenshot)
Author: Annaheim.h@gmail.com <Anna Hiragi>
Date:   Sat Jan 6 09:14:22 2024 +0900

    [docs] Update Screenshot in "Getting Started with Rails"
    
    Replace the existing screenshot with the output produced in Rails 7. The current screenshot
    seems to be captured in a previous version.

commit 6c0f897293f6b0dac2f3a60f454b8bbda0bcaf96 (origin/main, origin/HEAD, main)
Merge: bf725a7876 f68727dcd0
Author: Jean Boussier <jean.boussier@gmail.com>
Date:   Thu Dec 21 10:53:33 2023 +0100

    Merge pull request #50410 from fatkodima/fix-async-queries-with-query-cache
    
    Fix async queries to work with query cache

commit f68727dcd0f6c42ab327a99fa46c1a0f1704cdf4
Author: fatkodima <fatkodima123@gmail.com>
Date:   Wed Dec 20 23:50:35 2023 +0200

省略
rails_en_forked % git push --force-with-lease origin getting-started-update-screenshot
Enumerating objects: 13, done.
Counting objects: 100% (13/13), done.
Delta compression using up to 8 threads
Compressing objects: 100% (7/7), done.
Writing objects: 100% (7/7), 45.39 KiB | 22.70 MiB/s, done.
Total 7 (delta 4), reused 0 (delta 0), pack-reused 0
remote: Resolving deltas: 100% (4/4), completed with 4 local objects.
To https://github.com/Angy-h/rails_en_forked.git
 + ab88c70591...bd934475b9 getting-started-update-screenshot -> getting-started-update-screenshot (forced update)

プルリクエストの方も、再度、作成しました。
こちらの内容で、「Create pull request」をクリックしても良いでしょうか?
スクリーンショット 2024-01-15 19 04 47
スクリーンショット 2024-01-15 19 04 59

今回は、git --amendを実行すると、下記のようなメッセージが出てきました。
ChatGPTとスクールのAIに聞くと、git commit --amendを使う、ということでしたので、git commit --amendを使用しました。
この間は、確かにgit --amendを使ってコミットメッセージの修正ができたのですが。。。

rails_en_forked % git --amend
unknown option: --amend
usage: git [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]
           [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
           [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--bare]
           [--git-dir=<path>] [--work-tree=<path>] [--namespace=<name>]
           [--config-env=<name>=<envvar>] <command> [<args>]

@kou
Copy link

kou commented Jan 15, 2024

クリックしてください!

git --amendで修正はできないと思いますけど。。。コマンドライン履歴が残っていれば前に実行したコマンドを確認できるんですけどねぇ。

@Angy-h
Copy link
Author

Angy-h commented Jan 15, 2024

ご確認ありがとうございます!
先ほど、「Create pull request」をクリックしました!

上記を見直しますと、確かにgit commit --amendでご指示いただいていました。
どこで抜け落ちたのか、私の勘違いでした。申し訳ございません。

@kou
Copy link

kou commented Jan 15, 2024

rails/rails#50756 っすね!

@Angy-h
Copy link
Author

Angy-h commented Jan 15, 2024

はい!その通りです!

@yasulab
Copy link
Member

yasulab commented Jan 17, 2024

@Angy-h 無事にマージされましたね!! おめでとうございます...!!! 🥳🎉✨

もしよければ本リポジトリ(Railsガイド)の方にも同じ内容でプルリクを送っていただけると嬉しいです...!! cc/ @hachi8833 (コチラは日本語のDescriptionで大丈夫です!)

@Angy-h
Copy link
Author

Angy-h commented Jan 17, 2024

ありがとうございます!無事にマージされてとても嬉しいです。
(railsガイドの英語のページを見に行くのは、気持ちを落ち着けてからにします。。。)
皆様からご丁寧にご指導いただいて、私のような初心者にも理解しやすいよう説明くださりお導きいただいたおかげでございます。
様々に勉強させていただいて感謝しかございません。本当にありがとうございます。

日本語のrailsガイド方にもスクリーンショットのプルリクエストをお送りすることになっていること、承知いたしました。
お教えいただいた手順を見直して、準備いたします。

一つお伺いさせていただければと思います。
日本語Railsガイドの同じく「Rails をはじめよう」の中の9.3の「concernを使う」というセクションで、次のような記載があります。

1つのconcernは、モデルの責務の「一部」についてのみ責任を負います。この例の場合、「関心(concern)」の対象となるメソッドはすべてモデルの可視性に関連しているので。新しいconcern(すなわちモジュール)をVisibleと呼ぶことにしましょう。

この中の「関連しているので。」の「。」は、「、」ではないかな?と気になっています。
ご確認いただけますでしょうか。
もし「、」の方でしたら、スクリーンショットの分と一緒に送った方がよいでしょうか、別にした方がよいでしょうか、それとも、簡単にご対応されることが可能なので特に送る必要はないのかもしれません。
ご教示いただけましたら幸いです。

@yasulab
Copy link
Member

yasulab commented Jan 17, 2024

@Angy-h 句読点の部分はミスっぽいですね! 😂 まとめて送っていただいても別々に送っていただいても、どちらでも大丈夫です...!! 🆗✨ (やりやすい方で 😆👌)

@kou
Copy link

kou commented Jan 18, 2024

やりましたね!

今回のようにメンテナンスしている人からまとめてでいいよーと言ってもらっている場合はまとめてでもいいんですが、一般的には、論理的に分離できる変更は別々に送るのがいいです。別々に送ると、それぞれでよさそうねとなった段階で個別にマージしていけますが、まとめて送ると、一部の変更がネックになった場合に、変更全体がマージできないからです。

@Angy-h
Copy link
Author

Angy-h commented Jan 18, 2024

はい!先ほど勇気を出して英語のrailsガイドの該当箇所を見てきましたところ、新しい画像に更新されていました!
小さくなりすぎてたり、大きすぎたりしたら、と不安でしたが、普通に写っていました。
ほっとしたと共にとても感動しています。
ここまでお導きくださり本当にありがとうございます。

日本語のrailsガイドの方、プルリクエストを送れるように教えていただいた手順を見直して進めます。
ご教示いただきましたように、別々にお送りするようにいたします。

@Angy-h
Copy link
Author

Angy-h commented Jan 19, 2024

お世話になります。
プルリクエストを2件に分けて送信し、マージされた後のネット上の結果を確認しましたので、ご報告いたします。
@hachi8833 さん、ご対応くださりありがとうございました。

ご教示いただいた手順をまとめましたので、今後の参考のため、下記に残しておきます。
プルリクエスト作成のための参照GitHubの公式ドキュメント
https://docs.github.com/ja/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request

手順

  1. 目的のリポジトリに行く

  2. リポジトリをフォーク・クローンする
     参照ドキュメント:https://docs.github.com/ja/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo
     (1)リポジトリをフォークする
     (2)フォークしたリポジトリのクローンする
     (3)アップストリームのリポジトリと同期させる

  3. トピックブランチを作成する
    git switch -c [ブランチ名]

  4. HTMLを生成し対象を確認する
     参照ドキュメント
     ・英語版の場合:https://railsguides.jp/ruby_on_rails_guides_guidelines.html#html%E3%82%AC%E3%82%A4%E3%83%89
     ・日本語版の場合:READMEの中のRails ガイドの生成方法
    https://github.com/yasslab/railsguides.jp

  5. トピックブランチで必要な変更を行う

  6. HTMLを生成し結果を確認する

  7. 変更をコミットしてプッシュする

guides$ git add [対象ファイル]
guides$ git commit -m "メッセージ"
guides$ git push origin [対象ファイル]

(1)コミットメッセージ作成について(フォーマットや時制)
参照:https://pyteyon.hatenablog.com/entry/2020/02/27/092101#%E3%82%B3%E3%83%9F%E3%83%83%E3%83%88%E3%83%A1%E3%83%83%E3%82%BB%E3%83%BC%E3%82%B8%E3%81%AE%E3%83%95%E3%82%A9%E3%83%BC%E3%83%9E%E3%83%83%E3%83%88
3行で送る場合は、-m "メッセージ"を付けないで、git commitを実行する。
(2)コミットメッセージを修正したい場合
git commit --amend
参照:https://qiita.com/workman02/items/6b4ed4f906d62aba02a0

  1. プルリクエストのタイトルと本文のドラフトを作成する

  2. プルリクエストを作成&送信する
    参照:
     github公式:https://docs.github.com/ja/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request
     参考:https://note.com/llminatoll/n/n03bf5aac004b

@yasulab yasulab changed the title RailガイドのRails をはじめようの8.4「コントローラを生成する」について Railsガイドの「Rails をはじめよう」にある「8.4 コントローラを生成する」について Jan 31, 2024
@yasulab
Copy link
Member

yasulab commented Jan 31, 2024

プルリクエストを2件に分けて送信し、マージされた後のネット上の結果を確認しましたので、ご報告いたします。 @hachi8833 さん、ご対応くださりありがとうございました。

本件について英語版のRails Guides含め、ご対応いただきありがとうございました!👏✨

本 Issue のタイトルにある件については以下のプルリクエストで対応されましたので、本 Issue は Close しますね。改めて、対応ありがとうございました...!! 🙏 💖

@yasulab yasulab closed this as completed Jan 31, 2024
@Angy-h
Copy link
Author

Angy-h commented Jan 31, 2024

ご丁寧にご連絡くださりありがとうございます。
私の方こそ色々とお世話になりまして、ありがとうございました!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants