From 25d372ec609e9a40d55b0bc007f12e1ad46c6687 Mon Sep 17 00:00:00 2001 From: kazzyfrog <70629747+kazzyfrog@users.noreply.github.com> Date: Thu, 21 Mar 2024 06:54:31 +0900 Subject: [PATCH 1/7] =?UTF-8?q?:books:=20docs:=20=20README=E3=81=AE?= =?UTF-8?q?=E4=BD=9C=E6=88=90=20#8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 266 +++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 243 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index c403366..df1ce0f 100644 --- a/README.md +++ b/README.md @@ -1,36 +1,256 @@ -This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app). +[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/) + + -## Getting Started +# First Contributions ja -First, run the development server: +> 完全日本語のチュートリアルで、OSS 活動を始める 🚀 -```bash -npm run dev -# or -yarn dev -# or -pnpm dev -# or -bun dev -``` +初心者でも簡単に参加できるように設計された、日本語のオープンソースプロジェクトです。
+チュートリアルに沿って、初めての貢献（コントリビュート）を体験してください！ -Open [http://localhost:3000](http://localhost:3000) with your browser to see the result. +あなたの最初のプルリクエストを喜んでお手伝いします ✌️ -You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file. +
-This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font. +## はじめに -## Learn More +このプロジェクトは、Git/Github の実践的な使い方や、オープンソースでコラボレーションする作法を学ぶための、日本語のチュートリアルです！ -To learn more about Next.js, take a look at the following resources: +### これは誰のためのものですか？ -- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API. -- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial. +- Git/ Github の、実践的な使い方を学びたい初心者 +- オープンソースに興味があるが、どのように貢献すればよいかわからない人々 +- もしくは、より多くの貢献を通して、コラボレーションを楽しみながら、スキルを高めたい方 -You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome! +### このプロジェクトの目的は？ -## Deploy on Vercel +- 1 人では学習しずらい、Github を使った実際の共同開発を体験すること +- 誰もが自信を持って、オープンソースプロジェクトに貢献する方法を学ぶこと +- そして、オープンソースカルチャーが好きな開発者同士が、繋がる手助けをすること -The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js. +### なぜオープンソースに貢献するの？ -Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details. +オープンソースのプロジェクトに貢献することは、知識を共有し、他の開発者と協力する素晴らしい方法です。 + +もしあなたがオープンソースに無関心で、労力を割く必要があるかどうか疑問に思っているなら、
+こちらを参照してみて下さい：[オープンソースにコントリビュートする理由は？](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) + +
+ +## 参加方法 + +さっそくオープンソースプロジェクトへの貢献を、体験してみましょう！ + +### どんな貢献をすればいいの？ + +このプロジェクトの参加者として、Contributors.json ファイルに必要な情報を記載し、プロフィールカードを作成します！ + +> 🚧TODO:
+> データファイルの中のデータと表示するカード？のスクリーンショットを記載して、
+> これから行う作業を明確にする + +これから行うチュートリアルは、次の９つのステップで完了します！
+実際に手を動かしてみてください :octocat: + +- [実際に手を動かす](#実際に手を動かす) + - [セットアップ:](#セットアップ) + - [Step 1: このリポジトリをフォーク](#step-1このリポジトリをフォーク) + - [Step 2: ローカルマシンへクローン](#step-2ローカルマシンへクローン) + - [Step 3: 作業用ブランチを作成](#step-3作業用ブランチを作成) + - [Step 4: 変更を加える](#step-4変更を加える) + - [Step 5: 変更をコミット](#step-5変更をコミット) + - [Step 6: 変更をプッシュ](#step-6変更をプッシュ) + - [Step 7: プルリクエスト（PR）を作成](#step-7プルリクエストprを作成) + - [Step 8: レビューとフィードバックに対応](#step-8レビューとフィードバックに対応) + - [Finish: 🎉](#finish) +- [さらなるステップ](#さらなるステップ) +- [その他の貢献](#その他の貢献) + +## 実際に手を動かす + +> 9 つの簡単なステップで、オープンソースのコントリビューターになる :sunglasses: + +- もし助けが必要な場合、[ディスカッション](https://github.com/first-contributions-ja/first-contributions-ja.github.io/discussions)で質問してください！ +- このプロジェクトに関する改善点を見つけた場合は、[Issues](https://github.com/JavaScript-Starters/JS-RnR-ja/issues) から報告してください！ + +どんな些細なことでも、大歓迎です 🙌 + +--- + +### セットアップ： + +- もし GitHub のアカウントを持っていない場合は、[Sign up](https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home)からアカウントを作成してください。 + - そして、必要に応じて全くの初心者向けの[GitHub Hello World のチュートリアル](https://docs.github.com/ja/get-started/quickstart/hello-world)を先に行うことをお勧めします。 +- パスワードの代わりとなるアクセストークンが設定されていない場合、クローンなどのタイミングでエラーが生じることがあります。 + - その場合は[Github アクセストークンの設定](https://docs.github.com/ja/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)を参照してください。 + +--- + +### Step 1:このリポジトリをフォーク + +- Github 上のプロジェクトページの右上にある "Fork" ボタンをクリックして、このリポジトリをフォークします。 +- そして、"Create fork"ボタンをクリックします。 + +これにより、あなたの GitHub アカウントに、このリポジトリのコピーが作成されます 👍 + +--- + +### Step 2:ローカルマシンへクローン + +Github 上でファイルを編集することも可能ですが、
+より一般的なワークフローを体験するため、フォークしたリポジトリをあなたのローカルマシンにコピーします。 + +- ターミナルを開き、リポジトリをクローンするディレクトリに移動します。 + - 例えば、クローン先をデスクトップに指定する場合、以下のコマンドを使用できます。 + ``` + cd desktop + ``` +- GitHub 上のフォークしたのリポジトリのページに移動し、緑色の "Code" ボタンからクローンする URL をコピーします。 + - URL は、次のようになっているはずです；`https://github.com/<あなたのアカウント名>/first-contributions-ja.github.io.git` +- 以下のコマンドを使用して、フォークしたリポジトリをローカルマシンにクローンします： + ``` + git clone 先ほどコピーしたクローンURL + ``` + +これにより、リポジトリがあなたのローカルマシンにコピーされ、ローカル環境で作業することが可能になりました 💻 + +--- + +### Step 3:作業用ブランチを作成 + +- 次のコマンドでリポジトリのディレクトリ内に移動します：`cd first-contributions-ja` +- プロジェクトの`main`ブランチからあなたの作業を切り離すために、新しいブランチを作成してください。 + - 以下のコマンドを使用できます： + ``` + git switch -c <ブランチ名> + ``` +- ブランチ名は、あなたがこれから行う作業に関連した意味のある名前を付けます。 + - 例えば以下のようになります（`yourname`をあなたのハンドルネームに置き換えることを忘れないでください）： + ``` + git switch -c add-yourname + ``` + +これにより、プロジェクトの`main`リポジトリに直接影響を与えることなく、変更を加える準備が整いました 🍵 + +--- + +### Step 4:変更を加える + +- 作業を開始するため、VSCode などのお好きなコードエディタで、クローンしたフォルダを開きます。 + - 変更を加える前に、前のステップで作成したブランチで作業することを確認してください。 +- それでは Contributors.json ファイルに変更を加えます。 + - Contributors.json ファイルを１番下までスクロールし、リストの最後に、以下のコードを貼り付けます。 + ``` + ,{ + "name": "あなたのハンドルネーム", + "github": "あなたのGithubアカウントのURL", + "favoriteStack": "あなたの好きなプログラミング言語・技術スタック", + "text": "自己紹介・挨拶" + } + ``` +- そして、貼り付けたテキストの中身を、あなた独自の内容に置き換えます + - 例えば、全て置き換えたら以下のようになります： + ``` + + ,{ + "name": "git taro", + "github": "https://github.com/first-contributions-ja", + "favoriteStack": "Github", + "text": "ごきげんよう 日本🍡" + } + ``` + +> 🚧TODO:
+> データファイルの中のデータの値を確定させる
+> name は不要かも。個別ページを生成する場合、重複できない値を slug にしたいので、Github のアカウント URL だけ記載して貰えば、ユニークなユーザー名を抽出できる + +> 🚧TODO:
+> 変更を加えるユーザーの VSCode に、prettier が入っていないケースを前提に、Github Actions で、コードの整形を矯正したい。 + +--- + +### Step 5:変更をコミット + +- 以下のコマンドを使用して、変更をローカルリポジトリにコミットします。 + - `yourname`をあなたのハンドルネームに置き換えることを忘れないでください。 + ``` + git add . + git commit -m "yournameをコントリビューターに追加" + ``` + +これにより、あなたが Contributors.json ファイルに加えた変更が、記録されます 📝 + +--- + +### Step 6:変更をプッシュ + +- フォークしたリモートリポジトリに変更をプッシュします： + ``` + git push origin HEAD + ``` + +--- + +### Step 7:プルリクエスト（PR）を作成 + +- GitHub 上の、フォークしたリモートリポジトリのページ（`https://github.com/あなたのアカウント/first-contributions-ja`）に移動します。 +- 上部に表示されている"Compare & pull request" ボタンをクリックします。 +- そして、"Create pull request" ボタンをクリックします。 + +これにより、あなたがフォークして行った変更を、フォーク元のリポジトリに反映させるようにリクエストします 🎁 + +--- + +### Step 8:レビューとフィードバックに対応 + +プロジェクトのメンテナーによって、あなたの PR がレビューされます。 + +- レビュアーが PR に対して変更を求めるのはごく普通のことです。もしそれが起こっても、よくある事だと考えて修正を加えてください。 + - その場合、先ほどと同じ作業用ブランチに戻り、要求された修正を行ったら、同じように[変更をコミット](#step-5変更をコミット)してプッシュするだけです。 + - PR は新しいプッシュによって、自動的に更新されます。 + +ほとんどの場合は 24 時間以内にレビューしますが、数日の遅れが発生することもあります。気長にお待ちください。 + +--- + +### Finish:🎉 + +- プルリクエストが承認されると、それはメインプロジェクトにマージされます。 + +お疲れ様です！
+そして first-contributions-ja に時間と労力を割いて貢献していただきありがとうございます！！ + +
+ +## さらなるステップ + +> あなたは、オープンソースのプロジェクトに貢献する方法を学びました！ + +もしこのプロジェクトが役に立つと思った場合は、ページの上部から ⭐**star ボタン**を押してください！
+また、このプロジェクトを広めるために、フォロワーや知り合いに共有してください！ + +- 行った作業を振り返って、知識を定着させてください。 + - あなたはコントリビューターとしてよく体験する、標準的なワークフロー（**ドキュメントを読む → フォーク → 変更を加える → プルリクエスト**）を完了したところです！ +- first-contributions-ja は、オープンソースで運営・開発されているプロジェクトなので、上記の[チュートリアル](#実際に手を動かす)とは**別の形で貢献**することもできます。 + - もし興味があれば、[その他の貢献](#その他の貢献)を確認してください。 + - または、[ディスカッション](https://github.com/first-contributions-ja/first-contributions-ja.github.io/discussions)にて、このプロジェクトに関する感想を聞かせてください 🙌 +- 他のオープンソースプロジェクトにも、貢献してみてください！ + - Guthub 上の初心者向けのトピック([first-contributions](https://github.com/topics/first-contributions)や[good-first-issue](https://github.com/topics/good-first-issue)）を是非チェックしてみてて！ + - 貢献したいリポジトリがあれば、「**good first issue**」というラベルのついたイシューを探してください。 + - これは一般的に、特定のプロジェクトやオープンソース自体に慣れていない初心者向けのイシューであることを表します！ + +
+ +## その他の貢献 + +より多くの貢献がしたい方は、[貢献ガイドライン](./CONTRIBUTING.md)を参照してください！
+コードの追加やバグの修正、ドキュメントの改善など、どんな些細な貢献も大歓迎です 🤝 + +## ライセンス + +このプロジェクトは、[MIT ライセンス](/LICENSE)の下でライセンスされています。 + +## 謝辞 + +このプロジェクトは、[first-contributions](https://github.com/firstcontributions/first-contributions)や[Contribute-To-This-Project](https://github.com/Syknapse/Contribute-To-This-Project)などの、初心者フレンドリーに設計された素晴らしいプロジェクトから影響を受けています！ From 0b420016bff5f15470a5509a1e2f8fecbd1198c5 Mon Sep 17 00:00:00 2001 From: kazzyfrog <70629747+kazzyfrog@users.noreply.github.com> Date: Thu, 21 Mar 2024 07:19:15 +0900 Subject: [PATCH 2/7] =?UTF-8?q?:books:=20docs:=20=E3=83=AA=E3=83=B3?= =?UTF-8?q?=E3=82=AF=E3=81=AE=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index df1ce0f..f057378 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ > 9 つの簡単なステップで、オープンソースのコントリビューターになる :sunglasses: - もし助けが必要な場合、[ディスカッション](https://github.com/first-contributions-ja/first-contributions-ja.github.io/discussions)で質問してください！ -- このプロジェクトに関する改善点を見つけた場合は、[Issues](https://github.com/JavaScript-Starters/JS-RnR-ja/issues) から報告してください！ +- このプロジェクトに関する改善点を見つけた場合は、[Issues]([https://github.com/JavaScript-Starters/JS-RnR-ja/issues](https://github.com/first-contributions-ja/first-contributions-ja.github.io/issues)) から報告してください！ どんな些細なことでも、大歓迎です 🙌 @@ -244,7 +244,7 @@ Github 上でファイルを編集することも可能ですが、
## その他の貢献 -より多くの貢献がしたい方は、[貢献ガイドライン](./CONTRIBUTING.md)を参照してください！
+より多くの貢献がしたい方は、[貢献ガイドライン](./docs/CONTRIBUTING.md)を参照してください！
コードの追加やバグの修正、ドキュメントの改善など、どんな些細な貢献も大歓迎です 🤝 ## ライセンス From 623b9a883f880046065258ad5d6226048afb6c35 Mon Sep 17 00:00:00 2001 From: kazzyfrog <70629747+kazzyfrog@users.noreply.github.com> Date: Thu, 21 Mar 2024 07:27:18 +0900 Subject: [PATCH 3/7] =?UTF-8?q?:books:=20docs:=20=E6=AD=A3=E3=81=97?= =?UTF-8?q?=E3=81=8F=E3=81=AA=E3=81=84=E3=83=AA=E3=83=B3=E3=82=AF=E3=81=AE?= =?UTF-8?q?=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f057378..4d401a5 100644 --- a/README.md +++ b/README.md @@ -72,7 +72,7 @@ > 9 つの簡単なステップで、オープンソースのコントリビューターになる :sunglasses: - もし助けが必要な場合、[ディスカッション](https://github.com/first-contributions-ja/first-contributions-ja.github.io/discussions)で質問してください！ -- このプロジェクトに関する改善点を見つけた場合は、[Issues]([https://github.com/JavaScript-Starters/JS-RnR-ja/issues](https://github.com/first-contributions-ja/first-contributions-ja.github.io/issues)) から報告してください！ +- このプロジェクトに関する改善点を見つけた場合は、[Issues](https://github.com/first-contributions-ja/first-contributions-ja.github.io/issues) から報告してください！ どんな些細なことでも、大歓迎です 🙌 From 4d36dfb39644498f37ad50489e2c2d4f06cb3778 Mon Sep 17 00:00:00 2001 From: kazzyfrog <70629747+kazzyfrog@users.noreply.github.com> Date: Thu, 21 Mar 2024 16:41:40 +0900 Subject: [PATCH 4/7] =?UTF-8?q?:books:=20docs:=20=E3=83=90=E3=83=83?= =?UTF-8?q?=E3=82=B8=E3=81=AE=E8=BF=BD=E5=8A=A0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 23 +++++++++++++---------- 1 file changed, 13 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 4d401a5..ff3c3cc 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,9 @@ +[![Deploy Next.js site to Pages](https://github.com/first-contributions-ja/first-contributions-ja.github.io/actions/workflows/nextjs.yml/badge.svg)](https://github.com/first-contributions-ja/first-contributions-ja.github.io/actions/workflows/nextjs.yml) +![Static Badge](https://img.shields.io/badge/PRs-welcome-brightgreen?style=flat) [![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/) +[![Static Badge](https://img.shields.io/badge/first_contributions-%F0%9F%94%B0-white?style=flat)](https://github.com/topics/first-contributions) # First Contributions ja @@ -71,7 +74,7 @@ > 9 つの簡単なステップで、オープンソースのコントリビューターになる :sunglasses: -- もし助けが必要な場合、[ディスカッション](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)で質問してください！ - このプロジェクトに関する改善点を見つけた場合は、[Issues](https://github.com/first-contributions-ja/first-contributions-ja.github.io/issues) から報告してください！ どんな些細なことでも、大歓迎です 🙌 @@ -210,7 +213,7 @@ Github 上でファイルを編集することも可能ですが、
- その場合、先ほどと同じ作業用ブランチに戻り、要求された修正を行ったら、同じように[変更をコミット](#step-5変更をコミット)してプッシュするだけです。 - PR は新しいプッシュによって、自動的に更新されます。 -ほとんどの場合は 24 時間以内にレビューしますが、数日の遅れが発生することもあります。気長にお待ちください。 +ほとんどの場合は 24 時間以内にレビューしますが、数日の遅れが発生することもあります。気長にお待ちください☕ --- @@ -219,27 +222,27 @@ Github 上でファイルを編集することも可能ですが、
- プルリクエストが承認されると、それはメインプロジェクトにマージされます。 お疲れ様です！
-そして first-contributions-ja に時間と労力を割いて貢献していただきありがとうございます！！ +そして first-contributions-ja に、時間と労力を割いて貢献していただきありがとうございます！！
## さらなるステップ -> あなたは、オープンソースのプロジェクトに貢献する方法を学びました！ - -もしこのプロジェクトが役に立つと思った場合は、ページの上部から ⭐**star ボタン**を押してください！
-また、このプロジェクトを広めるために、フォロワーや知り合いに共有してください！ +あなたは、オープンソースのプロジェクトに貢献する方法を学びました！ - 行った作業を振り返って、知識を定着させてください。 - あなたはコントリビューターとしてよく体験する、標準的なワークフロー（**ドキュメントを読む → フォーク → 変更を加える → プルリクエスト**）を完了したところです！ - first-contributions-ja は、オープンソースで運営・開発されているプロジェクトなので、上記の[チュートリアル](#実際に手を動かす)とは**別の形で貢献**することもできます。 - もし興味があれば、[その他の貢献](#その他の貢献)を確認してください。 - - または、[ディスカッション](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)にて、このプロジェクトに関する感想を聞かせてください 🙌 - 他のオープンソースプロジェクトにも、貢献してみてください！ - - Guthub 上の初心者向けのトピック([first-contributions](https://github.com/topics/first-contributions)や[good-first-issue](https://github.com/topics/good-first-issue)）を是非チェックしてみてて！ + - Guthub 上の初心者向けのトピック([first-contributions](https://github.com/topics/first-contributions)や[good-first-issue](https://github.com/topics/good-first-issue)）をチェックしてみてください！ - 貢献したいリポジトリがあれば、「**good first issue**」というラベルのついたイシューを探してください。 - これは一般的に、特定のプロジェクトやオープンソース自体に慣れていない初心者向けのイシューであることを表します！ +> もしこのプロジェクトが役に立つと思った場合は、ページの上部から ⭐**star ボタン**を押してください！
+また、このプロジェクトを広めるために、フォロワーや知り合いに共有してください！ +
## その他の貢献 @@ -253,4 +256,4 @@ Github 上でファイルを編集することも可能ですが、
## 謝辞 -このプロジェクトは、[first-contributions](https://github.com/firstcontributions/first-contributions)や[Contribute-To-This-Project](https://github.com/Syknapse/Contribute-To-This-Project)などの、初心者フレンドリーに設計された素晴らしいプロジェクトから影響を受けています！ +このプロジェクトは、[first-contributions](https://github.com/firstcontributions/first-contributions)や[Contribute-To-This-Project](https://github.com/Syknapse/Contribute-To-This-Project)などの、初心者フレンドリーに設計された素晴らしいプロジェクトから影響を受けています。 From 2ffab1ed02fb4018e406fcc108676c582266c0d1 Mon Sep 17 00:00:00 2001 From: kazzyfrog <70629747+kazzyfrog@users.noreply.github.com> Date: Thu, 21 Mar 2024 17:59:31 +0900 Subject: [PATCH 5/7] =?UTF-8?q?:books:=20docs:=20TODO=E3=81=AE=E3=82=B3?= =?UTF-8?q?=E3=83=A1=E3=83=B3=E3=83=88=E3=82=A2=E3=82=A6=E3=83=88?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 32 ++++++++++++++++++++------------ 1 file changed, 20 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index ff3c3cc..c4f8d4d 100644 --- a/README.md +++ b/README.md @@ -46,12 +46,20 @@ さっそくオープンソースプロジェクトへの貢献を、体験してみましょう！ ### どんな貢献をすればいいの？ + -このプロジェクトの参加者として、Contributors.json ファイルに必要な情報を記載し、プロフィールカードを作成します！ +> このプロジェクトの参加者として、Contributors.json ファイルに必要な情報を入力し、プロフィールカードを作成します！ -> 🚧TODO:
-> データファイルの中のデータと表示するカード？のスクリーンショットを記載して、
-> これから行う作業を明確にする +記載する情報は、以下のとおりです： +``` +"name": "あなたのハンドルネーム", +"github": "あなたのGithubアカウントのURL", +"favoriteStack": "あなたの好きなプログラミング言語・技術スタック", +"text": "自己紹介・挨拶" +``` これから行うチュートリアルは、次の９つのステップで完了します！
実際に手を動かしてみてください :octocat: @@ -109,7 +117,7 @@ Github 上でファイルを編集することも可能ですが、
``` cd desktop ``` -- GitHub 上のフォークしたのリポジトリのページに移動し、緑色の "Code" ボタンからクローンする URL をコピーします。 +- GitHub 上の、フォークしたリポジトリのページに移動し、緑色の "Code" ボタンからクローンする URL をコピーします。 - URL は、次のようになっているはずです；`https://github.com/<あなたのアカウント名>/first-contributions-ja.github.io.git` - 以下のコマンドを使用して、フォークしたリポジトリをローカルマシンにクローンします： ``` @@ -143,7 +151,7 @@ Github 上でファイルを編集することも可能ですが、
- 作業を開始するため、VSCode などのお好きなコードエディタで、クローンしたフォルダを開きます。 - 変更を加える前に、前のステップで作成したブランチで作業することを確認してください。 - それでは Contributors.json ファイルに変更を加えます。 - - Contributors.json ファイルを１番下までスクロールし、リストの最後に、以下のコードを貼り付けます。 + - **Contributors.json ファイルを１番下までスクロールし、リストの最後に、以下のコードを貼り付けます。** ``` ,{ "name": "あなたのハンドルネーム", @@ -164,12 +172,12 @@ Github 上でファイルを編集することも可能ですが、
} ``` -> 🚧TODO:
-> データファイルの中のデータの値を確定させる
-> name は不要かも。個別ページを生成する場合、重複できない値を slug にしたいので、Github のアカウント URL だけ記載して貰えば、ユニークなユーザー名を抽出できる - -> 🚧TODO:
-> 変更を加えるユーザーの VSCode に、prettier が入っていないケースを前提に、Github Actions で、コードの整形を矯正したい。 + + --- From c56544e82f7d51e6ddbe7b3216c05ce931af7345 Mon Sep 17 00:00:00 2001 From: kazzyfrog <70629747+kazzyfrog@users.noreply.github.com> Date: Sat, 23 Mar 2024 05:54:24 +0900 Subject: [PATCH 6/7] =?UTF-8?q?:books:=20docs:=20=E7=B4=B0=E3=81=8B?= =?UTF-8?q?=E3=81=84=E3=83=86=E3=82=AD=E3=82=B9=E3=83=88=E3=81=AE=E4=BF=AE?= =?UTF-8?q?=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 47 ++++++++++++++++++++--------------------------- 1 file changed, 20 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index c4f8d4d..8c7fb4d 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ ### これは誰のためのものですか？ -- Git/ Github の、実践的な使い方を学びたい初心者 +- Git/Github の、実践的な使い方を学びたい初心者 - オープンソースに興味があるが、どのように貢献すればよいかわからない人々 - もしくは、より多くの貢献を通して、コラボレーションを楽しみながら、スキルを高めたい方 @@ -46,10 +46,6 @@ さっそくオープンソースプロジェクトへの貢献を、体験してみましょう！ ### どんな貢献をすればいいの？ - > このプロジェクトの参加者として、Contributors.json ファイルに必要な情報を入力し、プロフィールカードを作成します！ @@ -58,7 +54,7 @@ "name": "あなたのハンドルネーム", "github": "あなたのGithubアカウントのURL", "favoriteStack": "あなたの好きなプログラミング言語・技術スタック", -"text": "自己紹介・挨拶" +"introduction": "自己紹介・挨拶" ``` これから行うチュートリアルは、次の９つのステップで完了します！
@@ -151,34 +147,30 @@ Github 上でファイルを編集することも可能ですが、
- 作業を開始するため、VSCode などのお好きなコードエディタで、クローンしたフォルダを開きます。 - 変更を加える前に、前のステップで作成したブランチで作業することを確認してください。 - それでは Contributors.json ファイルに変更を加えます。 - - **Contributors.json ファイルを１番下までスクロールし、リストの最後に、以下のコードを貼り付けます。** + - **Contributors.json ファイルの「リストの先頭」に、以下のコードをコピーして貼り付けます。** ``` - ,{ + { "name": "あなたのハンドルネーム", "github": "あなたのGithubアカウントのURL", - "favoriteStack": "あなたの好きなプログラミング言語・技術スタック", - "text": "自己紹介・挨拶" - } + "favoriteStack": "好きなプログラミング言語・技術スタックを１つ", + "introduction": "自己紹介・挨拶" + }, ``` -- そして、貼り付けたテキストの中身を、あなた独自の内容に置き換えます +- そして、貼り付けたテキストの中身を、あなた独自の内容に置き換えます。 - 例えば、全て置き換えたら以下のようになります： ``` - ,{ - "name": "git taro", - "github": "https://github.com/first-contributions-ja", - "favoriteStack": "Github", - "text": "ごきげんよう 日本🍡" - } + [ + { + "name": "oginochihiro", + "github": "https://github.com/first-contributions-ja", + "favoriteStack": "Github", + "introduction": "ここで働かせて下さい！" + }, + { + 〜〜 ``` - - - --- ### Step 5:変更をコミット @@ -260,8 +252,9 @@ Contributors.jsonに記載するデータの値を決める。 ## ライセンス -このプロジェクトは、[MIT ライセンス](/LICENSE)の下でライセンスされています。 +このプロジェクトは、[MIT LICENSE](/LICENSE)の下でライセンスされています。 ## 謝辞 -このプロジェクトは、[first-contributions](https://github.com/firstcontributions/first-contributions)や[Contribute-To-This-Project](https://github.com/Syknapse/Contribute-To-This-Project)などの、初心者フレンドリーに設計された素晴らしいプロジェクトから影響を受けています。 +このプロジェクトは、[first-contributions](https://github.com/firstcontributions/first-contributions)や[Contribute-To-This-Project](https://github.com/Syknapse/Contribute-To-This-Project)などの、
+初心者向けに設計された素晴らしいオープンソースプロジェクトから影響を受けています。 From 7b8f4d603f6261723da60f587ca08e4932ae41c6 Mon Sep 17 00:00:00 2001 From: kazzyfrog <70629747+kazzyfrog@users.noreply.github.com> Date: Sun, 24 Mar 2024 16:37:32 +0900 Subject: [PATCH 7/7] =?UTF-8?q?:books:=20docs:=20=E7=A9=BA=E7=99=BD?= =?UTF-8?q?=E3=82=84=E8=A1=A8=E8=A8=98=E3=81=AE=E4=BF=AE=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 8c7fb4d..0ac3e8a 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ [![Static Badge](https://img.shields.io/badge/first_contributions-%F0%9F%94%B0-white?style=flat)](https://github.com/topics/first-contributions) -# First Contributions ja +# First Contributions JA > 完全日本語のチュートリアルで、OSS 活動を始める 🚀 @@ -18,17 +18,17 @@ ## はじめに -このプロジェクトは、Git/Github の実践的な使い方や、オープンソースでコラボレーションする作法を学ぶための、日本語のチュートリアルです！ +このプロジェクトは、Git/GitHub の実践的な使い方や、オープンソースでコラボレーションする作法を学ぶための、日本語のチュートリアルです！ ### これは誰のためのものですか？ -- Git/Github の、実践的な使い方を学びたい初心者 +- Git/GitHub の、実践的な使い方を学びたい初心者 - オープンソースに興味があるが、どのように貢献すればよいかわからない人々 - もしくは、より多くの貢献を通して、コラボレーションを楽しみながら、スキルを高めたい方 ### このプロジェクトの目的は？ -- 1 人では学習しずらい、Github を使った実際の共同開発を体験すること +- 1 人では学習しずらい、GitHub を使った実際の共同開発を体験すること - 誰もが自信を持って、オープンソースプロジェクトに貢献する方法を学ぶこと - そして、オープンソースカルチャーが好きな開発者同士が、繋がる手助けをすること @@ -50,9 +50,10 @@ > このプロジェクトの参加者として、Contributors.json ファイルに必要な情報を入力し、プロフィールカードを作成します！ 記載する情報は、以下のとおりです： + ``` "name": "あなたのハンドルネーム", -"github": "あなたのGithubアカウントのURL", +"github": "あなたのGitHubアカウントのURL", "favoriteStack": "あなたの好きなプログラミング言語・技術スタック", "introduction": "自己紹介・挨拶" ``` @@ -79,7 +80,7 @@ > 9 つの簡単なステップで、オープンソースのコントリビューターになる :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) から報告してください！ +- このプロジェクトに関する改善点を見つけた場合は、[Issues](https://github.com/first-contributions-ja/first-contributions-ja.github.io/issues)から報告してください！ どんな些細なことでも、大歓迎です 🙌 @@ -90,13 +91,13 @@ - もし GitHub のアカウントを持っていない場合は、[Sign up](https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home)からアカウントを作成してください。 - そして、必要に応じて全くの初心者向けの[GitHub Hello World のチュートリアル](https://docs.github.com/ja/get-started/quickstart/hello-world)を先に行うことをお勧めします。 - パスワードの代わりとなるアクセストークンが設定されていない場合、クローンなどのタイミングでエラーが生じることがあります。 - - その場合は[Github アクセストークンの設定](https://docs.github.com/ja/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)を参照してください。 + - その場合は[GitHub アクセストークンの設定](https://docs.github.com/ja/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)を参照してください。 --- ### Step 1:このリポジトリをフォーク -- Github 上のプロジェクトページの右上にある "Fork" ボタンをクリックして、このリポジトリをフォークします。 +- GitHub 上のプロジェクトページの右上にある "Fork" ボタンをクリックして、このリポジトリをフォークします。 - そして、"Create fork"ボタンをクリックします。 これにより、あなたの GitHub アカウントに、このリポジトリのコピーが作成されます 👍 @@ -105,7 +106,7 @@ ### Step 2:ローカルマシンへクローン -Github 上でファイルを編集することも可能ですが、
+GitHub 上でファイルを編集することも可能ですが、
より一般的なワークフローを体験するため、フォークしたリポジトリをあなたのローカルマシンにコピーします。 - ターミナルを開き、リポジトリをクローンするディレクトリに移動します。 @@ -213,7 +214,7 @@ Github 上でファイルを編集することも可能ですが、
- その場合、先ほどと同じ作業用ブランチに戻り、要求された修正を行ったら、同じように[変更をコミット](#step-5変更をコミット)してプッシュするだけです。 - PR は新しいプッシュによって、自動的に更新されます。 -ほとんどの場合は 24 時間以内にレビューしますが、数日の遅れが発生することもあります。気長にお待ちください☕ +ほとんどの場合は 24 時間以内にレビューしますが、数日の遅れが発生することもあります。気長にお待ちください ☕ --- @@ -236,12 +237,12 @@ Github 上でファイルを編集することも可能ですが、
- もし興味があれば、[その他の貢献](#その他の貢献)を確認してください。 - または、[Discussions](https://github.com/first-contributions-ja/first-contributions-ja.github.io/discussions)にて、このプロジェクトに関する感想を聞かせてください 🙌 - 他のオープンソースプロジェクトにも、貢献してみてください！ - - Guthub 上の初心者向けのトピック([first-contributions](https://github.com/topics/first-contributions)や[good-first-issue](https://github.com/topics/good-first-issue)）をチェックしてみてください！ + - GitHub 上の初心者向けのトピック([first-contributions](https://github.com/topics/first-contributions)や[good-first-issue](https://github.com/topics/good-first-issue)）をチェックしてみてください！ - 貢献したいリポジトリがあれば、「**good first issue**」というラベルのついたイシューを探してください。 - これは一般的に、特定のプロジェクトやオープンソース自体に慣れていない初心者向けのイシューであることを表します！ > もしこのプロジェクトが役に立つと思った場合は、ページの上部から ⭐**star ボタン**を押してください！
-また、このプロジェクトを広めるために、フォロワーや知り合いに共有してください！ +> また、このプロジェクトを広めるために、フォロワーや知り合いに共有してください！