Skip to content

Commit f9258ab

Browse files
authored
📚 docs: READMEにチュートリアルの内容記載 #8
* 📚 docs: READMEの作成 #8 * 📚 docs: リンクの修正 * 📚 docs: 正しくないリンクの修正 * 📚 docs: バッジの追加 * 📚 docs: TODOのコメントアウト * 📚 docs: 細かいテキストの修正 * 📚 docs: 空白や表記の修正
1 parent 2d13b22 commit f9258ab

File tree

1 file changed

+247
-22
lines changed

1 file changed

+247
-22
lines changed

README.md

Lines changed: 247 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,261 @@
1-
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).
1+
[![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)
2+
![Static Badge](https://img.shields.io/badge/PRs-welcome-brightgreen?style=flat)
3+
[![Open Source Love](https://badges.frapsoft.com/os/v1/open-source.svg?v=103)](https://github.com/ellerbrock/open-source-badges/)
4+
<img src="https://img.shields.io/badge/license-MIT-blue.svg">
5+
<img src="https://img.shields.io/badge/contributions-welcome-blue.svg?style=flat">
6+
[![Static Badge](https://img.shields.io/badge/first_contributions-%F0%9F%94%B0-white?style=flat)](https://github.com/topics/first-contributions)
27

3-
## Getting Started
8+
# First Contributions JA
49

5-
First, run the development server:
10+
> 完全日本語のチュートリアルで、OSS 活動を始める 🚀
611
7-
```bash
8-
npm run dev
9-
# or
10-
yarn dev
11-
# or
12-
pnpm dev
13-
# or
14-
bun dev
12+
初心者でも簡単に参加できるように設計された、日本語のオープンソースプロジェクトです。<br>
13+
チュートリアルに沿って、初めての貢献(コントリビュート)を体験してください!
14+
15+
あなたの最初のプルリクエストを喜んでお手伝いします ✌️
16+
17+
<br>
18+
19+
## はじめに
20+
21+
このプロジェクトは、Git/GitHub の実践的な使い方や、オープンソースでコラボレーションする作法を学ぶための、日本語のチュートリアルです!
22+
23+
### これは誰のためのものですか?
24+
25+
- Git/GitHub の、実践的な使い方を学びたい初心者
26+
- オープンソースに興味があるが、どのように貢献すればよいかわからない人々
27+
- もしくは、より多くの貢献を通して、コラボレーションを楽しみながら、スキルを高めたい方
28+
29+
### このプロジェクトの目的は?
30+
31+
- 1 人では学習しずらい、GitHub を使った実際の共同開発を体験すること
32+
- 誰もが自信を持って、オープンソースプロジェクトに貢献する方法を学ぶこと
33+
- そして、オープンソースカルチャーが好きな開発者同士が、繋がる手助けをすること
34+
35+
### なぜオープンソースに貢献するの?
36+
37+
オープンソースのプロジェクトに貢献することは、知識を共有し、他の開発者と協力する素晴らしい方法です。
38+
39+
もしあなたがオープンソースに無関心で、労力を割く必要があるかどうか疑問に思っているなら、<br>
40+
こちらを参照してみて下さい:[オープンソースにコントリビュートする理由は?](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)
41+
42+
<br>
43+
44+
## 参加方法
45+
46+
さっそくオープンソースプロジェクトへの貢献を、体験してみましょう!
47+
48+
### どんな貢献をすればいいの?
49+
50+
> このプロジェクトの参加者として、Contributors.json ファイルに必要な情報を入力し、プロフィールカードを作成します!
51+
52+
記載する情報は、以下のとおりです:
53+
54+
```
55+
"name": "あなたのハンドルネーム",
56+
"github": "あなたのGitHubアカウントのURL",
57+
"favoriteStack": "あなたの好きなプログラミング言語・技術スタック",
58+
"introduction": "自己紹介・挨拶"
1559
```
1660

17-
Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
61+
これから行うチュートリアルは、次の9つのステップで完了します!<br>
62+
実際に手を動かしてみてください :octocat:
63+
64+
- [実際に手を動かす](#実際に手を動かす)
65+
- [セットアップ:](#セットアップ)
66+
- [Step 1: このリポジトリをフォーク](#step-1このリポジトリをフォーク)
67+
- [Step 2: ローカルマシンへクローン](#step-2ローカルマシンへクローン)
68+
- [Step 3: 作業用ブランチを作成](#step-3作業用ブランチを作成)
69+
- [Step 4: 変更を加える](#step-4変更を加える)
70+
- [Step 5: 変更をコミット](#step-5変更をコミット)
71+
- [Step 6: 変更をプッシュ](#step-6変更をプッシュ)
72+
- [Step 7: プルリクエスト(PR)を作成](#step-7プルリクエストprを作成)
73+
- [Step 8: レビューとフィードバックに対応](#step-8レビューとフィードバックに対応)
74+
- [Finish: 🎉](#finish)
75+
- [さらなるステップ](#さらなるステップ)
76+
- [その他の貢献](#その他の貢献)
77+
78+
## 実際に手を動かす
79+
80+
> 9 つの簡単なステップで、オープンソースのコントリビューターになる :sunglasses:
81+
82+
- もし助けが必要な場合、[Discussions](https://github.com/first-contributions-ja/first-contributions-ja.github.io/discussions)で質問してください!
83+
- このプロジェクトに関する改善点を見つけた場合は、[Issues](https://github.com/first-contributions-ja/first-contributions-ja.github.io/issues)から報告してください!
84+
85+
どんな些細なことでも、大歓迎です 🙌
86+
87+
---
88+
89+
### セットアップ:
90+
91+
- もし GitHub のアカウントを持っていない場合は、[Sign up](https://github.com/signup?ref_cta=Sign+up&ref_loc=header+logged+out&ref_page=%2F&source=header-home)からアカウントを作成してください。
92+
- そして、必要に応じて全くの初心者向けの[GitHub Hello World のチュートリアル](https://docs.github.com/ja/get-started/quickstart/hello-world)を先に行うことをお勧めします。
93+
- パスワードの代わりとなるアクセストークンが設定されていない場合、クローンなどのタイミングでエラーが生じることがあります。
94+
- その場合は[GitHub アクセストークンの設定](https://docs.github.com/ja/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)を参照してください。
95+
96+
---
97+
98+
### Step 1:このリポジトリをフォーク
99+
100+
- GitHub 上のプロジェクトページの右上にある "Fork" ボタンをクリックして、このリポジトリをフォークします。
101+
- そして、"Create fork"ボタンをクリックします。
102+
103+
これにより、あなたの GitHub アカウントに、このリポジトリのコピーが作成されます 👍
104+
105+
---
106+
107+
### Step 2:ローカルマシンへクローン
108+
109+
GitHub 上でファイルを編集することも可能ですが、<br>
110+
より一般的なワークフローを体験するため、フォークしたリポジトリをあなたのローカルマシンにコピーします。
111+
112+
- ターミナルを開き、リポジトリをクローンするディレクトリに移動します。
113+
- 例えば、クローン先をデスクトップに指定する場合、以下のコマンドを使用できます。
114+
```
115+
cd desktop
116+
```
117+
- GitHub 上の、フォークしたリポジトリのページに移動し、緑色の "Code" ボタンからクローンする URL をコピーします。
118+
- URL は、次のようになっているはずです;`https://github.com/<あなたのアカウント名>/first-contributions-ja.github.io.git`
119+
- 以下のコマンドを使用して、フォークしたリポジトリをローカルマシンにクローンします:
120+
```
121+
git clone 先ほどコピーしたクローンURL
122+
```
123+
124+
これにより、リポジトリがあなたのローカルマシンにコピーされ、ローカル環境で作業することが可能になりました 💻
125+
126+
---
127+
128+
### Step 3:作業用ブランチを作成
129+
130+
- 次のコマンドでリポジトリのディレクトリ内に移動します:`cd first-contributions-ja`
131+
- プロジェクトの`main`ブランチからあなたの作業を切り離すために、新しいブランチを作成してください。
132+
- 以下のコマンドを使用できます:
133+
```
134+
git switch -c <ブランチ名>
135+
```
136+
- ブランチ名は、あなたがこれから行う作業に関連した意味のある名前を付けます。
137+
- 例えば以下のようになります(`yourname`をあなたのハンドルネームに置き換えることを忘れないでください):
138+
```
139+
git switch -c add-yourname
140+
```
141+
142+
これにより、プロジェクトの`main`リポジトリに直接影響を与えることなく、変更を加える準備が整いました 🍵
143+
144+
---
145+
146+
### Step 4:変更を加える
147+
148+
- 作業を開始するため、VSCode などのお好きなコードエディタで、クローンしたフォルダを開きます。
149+
- 変更を加える前に、前のステップで作成したブランチで作業することを確認してください。
150+
- それでは Contributors.json ファイルに変更を加えます。
151+
- **Contributors.json ファイルの「リストの先頭」に、以下のコードをコピーして貼り付けます。**
152+
```
153+
{
154+
"name": "あなたのハンドルネーム",
155+
"github": "あなたのGithubアカウントのURL",
156+
"favoriteStack": "好きなプログラミング言語・技術スタックを1つ",
157+
"introduction": "自己紹介・挨拶"
158+
},
159+
```
160+
- そして、貼り付けたテキストの中身を、あなた独自の内容に置き換えます。
161+
- 例えば、全て置き換えたら以下のようになります:
162+
```
163+
<!-- 変更後 -->
164+
[
165+
{
166+
"name": "oginochihiro",
167+
"github": "https://github.com/first-contributions-ja",
168+
"favoriteStack": "Github",
169+
"introduction": "ここで働かせて下さい!"
170+
},
171+
{
172+
〜〜
173+
```
174+
175+
---
176+
177+
### Step 5:変更をコミット
178+
179+
- 以下のコマンドを使用して、変更をローカルリポジトリにコミットします。
180+
- `yourname`をあなたのハンドルネームに置き換えることを忘れないでください。
181+
```
182+
git add .
183+
git commit -m "yournameをコントリビューターに追加"
184+
```
185+
186+
これにより、あなたが Contributors.json ファイルに加えた変更が、記録されます 📝
187+
188+
---
189+
190+
### Step 6:変更をプッシュ
191+
192+
- フォークしたリモートリポジトリに変更をプッシュします:
193+
```
194+
git push origin HEAD
195+
```
196+
197+
---
198+
199+
### Step 7:プルリクエスト(PR)を作成
200+
201+
- GitHub 上の、フォークしたリモートリポジトリのページ(`https://github.com/あなたのアカウント/first-contributions-ja`)に移動します。
202+
- 上部に表示されている"Compare & pull request" ボタンをクリックします。
203+
- そして、"Create pull request" ボタンをクリックします。
204+
205+
これにより、あなたがフォークして行った変更を、フォーク元のリポジトリに反映させるようにリクエストします 🎁
206+
207+
---
208+
209+
### Step 8:レビューとフィードバックに対応
210+
211+
プロジェクトのメンテナーによって、あなたの PR がレビューされます。
212+
213+
- レビュアーが PR に対して変更を求めるのはごく普通のことです。もしそれが起こっても、よくある事だと考えて修正を加えてください。
214+
- その場合、先ほどと同じ作業用ブランチに戻り、要求された修正を行ったら、同じように[変更をコミット](#step-5変更をコミット)してプッシュするだけです。
215+
- PR は新しいプッシュによって、自動的に更新されます。
216+
217+
ほとんどの場合は 24 時間以内にレビューしますが、数日の遅れが発生することもあります。気長にお待ちください ☕
218+
219+
---
220+
221+
### Finish:🎉
222+
223+
- プルリクエストが承認されると、それはメインプロジェクトにマージされます。
224+
225+
お疲れ様です!<br>
226+
そして first-contributions-ja に、時間と労力を割いて貢献していただきありがとうございます!!
227+
228+
<br>
229+
230+
## さらなるステップ
231+
232+
あなたは、オープンソースのプロジェクトに貢献する方法を学びました!
18233

19-
You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
234+
- 行った作業を振り返って、知識を定着させてください。
235+
- あなたはコントリビューターとしてよく体験する、標準的なワークフロー(**ドキュメントを読む → フォーク → 変更を加える → プルリクエスト**)を完了したところです!
236+
- first-contributions-ja は、オープンソースで運営・開発されているプロジェクトなので、上記の[チュートリアル](#実際に手を動かす)とは**別の形で貢献**することもできます。
237+
- もし興味があれば、[その他の貢献](#その他の貢献)を確認してください。
238+
- または、[Discussions](https://github.com/first-contributions-ja/first-contributions-ja.github.io/discussions)にて、このプロジェクトに関する感想を聞かせてください 🙌
239+
- 他のオープンソースプロジェクトにも、貢献してみてください!
240+
- GitHub 上の初心者向けのトピック([first-contributions](https://github.com/topics/first-contributions)[good-first-issue](https://github.com/topics/good-first-issue))をチェックしてみてください!
241+
- 貢献したいリポジトリがあれば、「**good first issue**」というラベルのついたイシューを探してください。
242+
- これは一般的に、特定のプロジェクトやオープンソース自体に慣れていない初心者向けのイシューであることを表します!
20243

21-
This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
244+
> もしこのプロジェクトが役に立つと思った場合は、ページの上部から ⭐**star ボタン**を押してください!<br>
245+
> また、このプロジェクトを広めるために、フォロワーや知り合いに共有してください!
22246
23-
## Learn More
247+
<br>
24248

25-
To learn more about Next.js, take a look at the following resources:
249+
## その他の貢献
26250

27-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
28-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
251+
より多くの貢献がしたい方は、[貢献ガイドライン](./docs/CONTRIBUTING.md)を参照してください!<br>
252+
コードの追加やバグの修正、ドキュメントの改善など、どんな些細な貢献も大歓迎です 🤝
29253

30-
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
254+
## ライセンス
31255

32-
## Deploy on Vercel
256+
このプロジェクトは、[MIT LICENSE](/LICENSE)の下でライセンスされています。
33257

34-
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.
258+
## 謝辞
35259

36-
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
260+
このプロジェクトは、[first-contributions](https://github.com/firstcontributions/first-contributions)[Contribute-To-This-Project](https://github.com/Syknapse/Contribute-To-This-Project)などの、<br>
261+
初心者向けに設計された素晴らしいオープンソースプロジェクトから影響を受けています。

0 commit comments

Comments
 (0)