📚 docs: チュートリアルの文章の修正 #165

* 📚 docs: チュートリアルの文章の修正 #165 * 📚 docs: URLとセミコロンの修正 * 📚 docs: 引用をテキストを太字に変更 * 📚 docs: 要約をアラートで強調
first-contributions-ja · Apr 5, 2024 · bbca93b · bbca93b
1 parent f628d5c
commit bbca93b
Showing 1 changed file with 67 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -33,26 +33,37 @@
 
 ### このプロジェクトの目的は？
 
-- 1 人では学習しずらい、GitHub を使った実際の共同開発を体験すること
+- 1 人では学習しづらい、GitHub を使った実際の共同開発を体験すること
 - 誰もが自信を持って、オープンソースプロジェクトに貢献する方法を学ぶこと
 - そして、オープンソースカルチャーが好きな開発者同士が、繋がる手助けをすること
 
-### なぜオープンソースに貢献するの？
-
-オープンソースのプロジェクトに貢献することは、知識を共有し、他の開発者と協力する素晴らしい方法です。
+<br>
 
-もしあなたがオープンソースに無関心で、労力を割く必要があるかどうか疑問に思っているなら、<br>
-こちらを参照してみて下さい：[オープンソースにコントリビュートする理由は？](https://opensource.guide/ja/how-to-contribute/#%E3%82%AA%E3%83%BC%E3%83%97%E3%83%B3%E3%82%BD%E3%83%BC%E3%82%B9%E3%81%AB%E3%82%B3%E3%83%B3%E3%83%88%E3%83%AA%E3%83%93%E3%83%A5%E3%83%BC%E3%83%88%E3%81%99%E3%82%8B%E7%90%86%E7%94%B1%E3%81%AF)
+<details>
+  <summary>そもそもオープンソースとは❓❓</summary>
+
+  [オープンソース](https://opensource.guide/ja/starting-a-project/#オープンソースとはなにでありなぜそれを行うのか)とは：
+
+  > あるプロジェクトがオープンソースである時、それは誰でも自由に使って、学び、修正して、あなたのプロジェクトをいかなる目的であっても配布できるということを意味します。
+  > 
+  ほとんどの場合、オープンソースのプロジェクトは、誰でも自由に開発に参加できます！
+
+  **オープンソースのプロジェクトに対して貢献（コントリビュート）することは、<br>
+  他の開発者との共同開発を通して、自身のスキルを高める素晴らしい方法です。**
+
+  もしあなたがオープンソースに無関心で、労力を割く必要があるかどうか疑問に思っているなら、<br>
+  こちらを参照してみて下さい：[オープンソースにコントリビュートする理由は？](https://opensource.guide/ja/how-to-contribute/#%E3%82%AA%E3%83%BC%E3%83%97%E3%83%B3%E3%82%BD%E3%83%BC%E3%82%B9%E3%81%AB%E3%82%B3%E3%83%B3%E3%83%88%E3%83%AA%E3%83%93%E3%83%A5%E3%83%BC%E3%83%88%E3%81%99%E3%82%8B%E7%90%86%E7%94%B1%E3%81%AF)
+</details> 
 
 <br>
 
 ## 参加方法
 
 さっそくオープンソースプロジェクトへの貢献を、体験してみましょう！
 
-### どんな貢献をすればいいの？
+### 何をすればいいの？
 
-> このプロジェクトの参加者として、Contributors.json ファイルに必要な情報を入力し、プロフィールを作成します！
+> **このプロジェクトの参加者として、Contributors.json ファイルに必要な情報を入力し、プロフィールを作成します！**
 
 記載する情報は、以下のとおりです：
 
@@ -83,7 +94,7 @@
 
 ## 実際に手を動かす
 
-> 8 つの簡単なステップで、オープンソースのコントリビューターになる :sunglasses:
+> **8 つの簡単なステップで、オープンソースのコントリビューターになる** :sunglasses:
 
 - もし助けが必要な場合、[Discussions](https://github.com/first-contributions-ja/first-contributions-ja.github.io/discussions)で質問してください！
 - このプロジェクトに関する改善点を見つけた場合は、[Issues](https://github.com/first-contributions-ja/first-contributions-ja.github.io/issues)から報告してください！
@@ -105,8 +116,10 @@
 
 - GitHub 上のプロジェクトページの右上にある "Fork" ボタンをクリックして、このリポジトリをフォークします。
 - そして、"Create fork"ボタンをクリックします。
+  - 「Repository name」「Description」「Copy the `main` branch only」などの項目は、すべて初期のままでOKです！
 
-これにより、あなたの GitHub アカウントに、このリポジトリのコピーが作成されます 👍
+> [!TIP]
+> これにより、あなたの GitHub アカウントに、このリポジトリのコピーが作成されます 👍
 
 ---
 
@@ -115,44 +128,58 @@
 GitHub 上でファイルを編集することも可能ですが、<br>
 より一般的なワークフローを体験するため、フォークしたリポジトリをあなたのローカルマシンにコピーします。
 
+- GitHub 上の、フォークしたリポジトリのページに移動し、緑色の "Code" ボタンをクリックし、HTTPS の URL をコピーします。
+  - URL は、次のようになっているはずです：`https://github.com/<あなたのアカウント名>/first-contributions-ja.github.io.git`
 - ターミナルを開き、リポジトリをクローンするディレクトリに移動します。
   - 例えば、クローン先をデスクトップに指定する場合、以下のコマンドを使用できます。
   ```
   cd desktop
   ```
-- GitHub 上の、フォークしたリポジトリのページに移動し、緑色の "Code" ボタンからクローンする URL をコピーします。
-  - URL は、次のようになっているはずです；`https://github.com/<あなたのアカウント名>/first-contributions-ja.github.io.git`
 - 以下のコマンドを使用して、フォークしたリポジトリをローカルマシンにクローンします：
   ```
   git clone 先ほどコピーしたクローンURL
   ```
 
-これにより、リポジトリがあなたのローカルマシンにコピーされ、ローカル環境で作業することが可能になりました 💻
+> [!TIP]
+> これにより、リポジトリがあなたのローカルマシンにコピーされ、ローカル環境で作業することが可能になりました 💻
 
 ---
 
 ### Step 3:作業用ブランチを作成
 
-- 次のコマンドでリポジトリのディレクトリ内に移動します：`cd first-contributions-ja`
-- プロジェクトの`main`ブランチからあなたの作業を切り離すために、新しいブランチを作成してください。
-  - 以下のコマンドを使用できます：
+- 次のコマンドで、リポジトリのディレクトリ内に移動します：
   ```
-  git switch -c <ブランチ名>
+  cd first-contributions-ja.github.io
   ```
-- ブランチ名は、あなたがこれから行う作業に関連した意味のある名前を付けます。
-  - 例えば以下のようになります（`yourname`をあなたのハンドルネームに置き換えることを忘れないでください）：
+- プロジェクトの`main`ブランチからあなたの作業を切り離すために、新しいブランチを作成してください。
+  - 次のコマンドを使用できます：`git switch -c <ブランチ名>`
+  - **ブランチ名**は、あなたがこれから行う作業に関連した意味のある名前を付けます。
+    なので、次のようになります：
   ```
   git switch -c add-yourname
   ```
+  - **🚧注意**）
+   - `yourname`をあなたのハンドルネームに置き換えることを忘れないでください
+   - ブランチ名には、ひらがな、漢字、空白は使わず、半角英数字で入力してください
+     - ❌: おぎのちひろ、荻野ちひろ、Ogino Chihiro
+   - 例：
+  ```
+  git switch -c add-oginochihiro 
+  ```
 
-これにより、プロジェクトの`main`リポジトリに直接影響を与えることなく、変更を加える準備が整いました 🍵
+> [!TIP]
+> これにより、プロジェクトの`main`リポジトリに直接影響を与えることなく、変更を加える準備が整いました 🍵
 
 ---
 
 ### Step 4:変更を加える
 
 - 作業を開始するため、VSCode などのお好きなコードエディタで、クローンしたフォルダを開きます。
-  - 変更を加える前に、前のステップで作成したブランチで作業することを確認してください。
+  - 変更を加える前に、前のステップで作成したブランチで作業することを確認してください！
+  - 次のコマンドで、現在のブランチを確認できます：
+  ```
+  git status
+  ```
 - それでは Contributors.json ファイルに変更を加えます。
   - **Contributors.json ファイルの「リストの先頭」に、以下のコードをコピーして貼り付けます。**
   ```
@@ -161,10 +188,11 @@ GitHub 上でファイルを編集することも可能ですが、<br>
     "github": "あなたのGitHubアカウントのURL",
     "favoriteStack": "あなたの好きなプログラミング言語・技術スタック",
     "favoriteColor": "あなたの好きなカラーコード",
-    "favoriteEmoji": "あなたの好きな絵文字",
+    "favoriteEmoji": "あなたの好きな絵文字"
   },
   ```
 - そして、貼り付けたテキストの中身を、あなた独自の内容に置き換えます。
+  - :art: 次のサイトを参考にしてみてください：[絵文字一覧](https://www.webfx.com/tools/emoji-cheat-sheet/)、[原色大辞典](https://www.colordic.org)、[日本の伝統色](https://nipponcolors.com)
   - 例えば、全て置き換えたら以下のようになります：
   ```
   <!-- 変更後 -->
@@ -184,14 +212,15 @@ GitHub 上でファイルを編集することも可能ですが、<br>
 
 ### Step 5:変更をコミット
 
-- 以下のコマンドを使用して、変更をローカルリポジトリにコミットします。
+- 再びターミナルに移動し、以下のコマンドを使用して、変更をローカルリポジトリにコミットします。
   - `yourname`をあなたのハンドルネームに置き換えることを忘れないでください。
   ```
   git add .
   git commit -m "yournameをコントリビューターに追加"
   ```
 
-これにより、あなたが Contributors.json ファイルに加えた変更が、記録されます 📝
+> [!TIP]
+> これにより、あなたが Contributors.json ファイルに加えた変更が、記録されます 📝
 
 ---
 
@@ -202,21 +231,27 @@ GitHub 上でファイルを編集することも可能ですが、<br>
   git push origin HEAD
   ```
 
+> [!TIP]
+> これにより、先ほどのコミット（ローカルでの変更内容）を、GitHub上のあなたのリモートリポジトリに反映させます 👾
+
 ---
 
 ### Step 7:プルリクエスト（PR）を作成
 
-- GitHub 上の、フォークしたリモートリポジトリのページ（`https://github.com/あなたのアカウント/first-contributions-ja`）に移動します。
+- GitHub 上の、フォークしたリモートリポジトリのページ（`https://github.com/あなたのアカウント/first-contributions-ja.github.io`）に移動します。
 - 上部に表示されている"Compare & pull request" ボタンをクリックします。
-- そして、"Create pull request" ボタンをクリックします。
+- そして、以下のことを確認したら、"Create pull request" ボタンをクリックします。
+  - 念のため、あなたのリポジトリの`add-yourname`ブランチから、first-contributions-jsの`main`ブランチに向かっていることを確認してください！
+  -  タイトルは初期入力のままで、description は空欄でOKです！
 
-これにより、あなたがフォークして行った変更を、フォーク元のリポジトリに反映させるようにリクエストします 🎁
+> [!TIP]
+> これにより、あなたがフォークして行った変更を、フォーク元のリポジトリに反映させるようにリクエストします 🎁
 
 ---
 
 ### Step 8:レビューとフィードバックに対応
 
-プロジェクトのメンテナーによって、あなたの PR がレビューされます。
+プロジェクトのメンテナーによって、あなたの PR がレビュー（確認）されます。
 
 - レビュアーが PR に対して変更を求めるのはごく普通のことです。もしそれが起こっても、よくある事だと考えて修正を加えてください。
   - その場合、先ほどと同じ作業用ブランチに戻り、要求された修正を行ったら、同じように[変更をコミット](#step-5変更をコミット)してプッシュするだけです。
@@ -228,7 +263,7 @@ GitHub 上でファイルを編集することも可能ですが、<br>
 
 ### Finish:🎉
 
-- プルリクエストが承認されると、それはメインプロジェクトにマージされます。
+- プルリクエストが承認されると、あなたが加えた変更はメインプロジェクトにマージされます。
 
 お疲れ様です！<br>
 そして First Contributions JA に、時間と労力を割いて貢献していただきありがとうございます！！
@@ -242,15 +277,16 @@ GitHub 上でファイルを編集することも可能ですが、<br>
 - 行った作業を振り返って、知識を定着させてください。
   - あなたはコントリビューターとしてよく体験する、標準的なワークフロー（**ドキュメントを読む → フォーク → 変更を加える → プルリクエスト**）を完了したところです！
 - First Contributions JA は、オープンソースで運営・開発されているプロジェクトなので、上記の[チュートリアル](#実際に手を動かす)とは**別の形で貢献**することもできます。
+  - [Discussions](https://github.com/first-contributions-ja/first-contributions-ja.github.io/discussions)にて、このプロジェクトに関する感想を聞かせてください 🙌
   - もし興味があれば、[その他の貢献](#その他の貢献)を確認してください。
-  - または、[Discussions](https://github.com/first-contributions-ja/first-contributions-ja.github.io/discussions)にて、このプロジェクトに関する感想を聞かせてください 🙌
 - 他のオープンソースプロジェクトにも、貢献してみてください！
   - GitHub 上の初心者向けのトピック([first-contributions](https://github.com/topics/first-contributions)や[good-first-issue](https://github.com/topics/good-first-issue)）をチェックしてみてください！
   - 貢献したいリポジトリがあれば、「**good first issue**」というラベルのついたイシューを探してください。
   - これは一般的に、特定のプロジェクトやオープンソース自体に慣れていない初心者向けのイシューであることを表します！
 
+> [!IMPORTANT]
 > もしこのプロジェクトが役に立つと思った場合は、ページの上部から ⭐**star ボタン**を押してください！<br>
-> また、このプロジェクトを広めるために、フォロワーや知り合いに共有してください！
+> また、このプロジェクトを広めるために、**フォロワーや知り合いに共有**してください！
 
 <br>