完全日本語のチュートリアルで、OSS 活動を始める
初心者でも簡単に参加できるように設計された、日本語のオープンソースプロジェクトです。
チュートリアルに沿って、初めての貢献(コントリビュート)を体験してください!
あなたの最初のプルリクエストを、喜んでお手伝いします ✌️
このプロジェクトは、Git/GitHub の実践的な使い方や、オープンソースでコラボレーションする作法を学ぶための、日本語のチュートリアルです!
オープンソースとは:
あるプロジェクトがオープンソースである時、それは誰でも自由に使って、学び、修正して、あなたのプロジェクトをいかなる目的であっても配布できるということを意味します。
ほとんどの場合、オープンソースのプロジェクトは、誰でも自由に開発に参加できます!
オープンソースのプロジェクトに対して貢献(コントリビュート)することは、
他の開発者との共同開発を通して、自身のスキルを高める素晴らしい方法です。
もしあなたがオープンソースに無関心で、労力を割く必要があるかどうか疑問に思っているなら、
こちらを参照してみて下さい:オープンソースにコントリビュートする理由は?
さっそくオープンソースプロジェクトへの貢献を、体験してみましょう!
このプロジェクトの参加者として、Contributors.json ファイルに下記の情報を追記します!
"name": "あなたのハンドルネーム",
"github": "あなたのGitHubアカウントのURL",
"favoriteColor": "あなたの好きなカラーコード",
"favoriteEmoji": "あなたの好きな絵文字"
入力された情報は、絵文字のアイコンとして、Webサイト上に表示されます。
なので、コントリビューターが増えるたびに、サイト上が賑やかになります!
私たちは、First Contributions JA の Web サイトを、今よりもっとPOPにしたいです!
ぜひ、実際に手を動かしてみてください
8 つの簡単なステップで、オープンソースのコントリビューターになる ?
どんな些細なことでも、大歓迎です ?
main branch only」などの項目は、すべて初期のままでOKです!
Tip
これにより、あなたの GitHub アカウントに、このリポジトリのコピーが作成されます ?
GitHub 上でファイルを編集することも可能ですが、
より一般的なワークフローを体験するため、フォークしたリポジトリをあなたのローカルマシンにコピーします。
https://github.com/<あなたのアカウント名>/first-contributions-ja.github.io.git
cd desktop
git clone 先ほどコピーしたクローンURL
Tip
これにより、リポジトリがあなたのローカルマシンにコピーされ、ローカル環境で作業することが可能になりました
次のコマンドで、リポジトリのディレクトリ内に移動します:
cd first-contributions-ja.github.io
次のコマンドで、このプロジェクトに必要なパッケージを、インストールします:
npm install
Node.jsがインストールされている状態で、npm installコマンドを実行すると、このプロジェクトに必要なライブラリを一括でインストールできます。
npm installした後にできることnpm run devコマンド実行後、表示されるURLをクリックすれば確認可能ですnpm installコマンドについて、より詳しい内容は、こちらを参照してみて下さい!
npm installコマンドで、エラーが発生します。その場合、2通りの対処法があります。
npm installの手順を飛ばす。
npm installがうまくいかなかった」といった報告をしていただけると大変参考になります。mainブランチからあなたの作業を切り離すために、新しいブランチを作成してください。
git switch -c <ブランチ名>git switch -c add-yourname
yournameをあなたのハンドルネームに置き換えることを忘れないでくださいgit switch -c add-oginochihiro
Tip
これにより、プロジェクトのmainリポジトリに直接影響を与えることなく、変更を加える準備が整いました ?
git status
,
{
"name": "あなたのハンドルネーム",
"github": "あなたのGitHubアカウントのURL",
"favoriteColor": "あなたの好きなカラーコード",
"favoriteEmoji": "あなたの好きな絵文字"
}
<!-- 変更後 -->
~~
},
{
"name": "oginochihiro",
"github": "https://github.com/first-contributions-ja",
"favoriteColor": "#ffffff",
"favoriteEmoji": "?"
}
]
yournameをあなたのハンドルネームに置き換えることを忘れないでください。git add .
git commit -m "yournameをコントリビューターに追加"
Tip
これにより、あなたが Contributors.json ファイルに加えた変更が、記録されます
git push origin HEAD
Tip
これにより、先ほどのコミット(ローカルでの変更内容)を、GitHub上のあなたのリモートリポジトリに反映させます ?
https://github.com/あなたのアカウント/first-contributions-ja.github.io)に移動します。
add-yournameブランチから、first-contributions-jsのmainブランチに向かっていることを確認してください!
Tip
これにより、あなたがフォークして行った変更を、フォーク元のリポジトリに反映させるようにリクエストします ?
プロジェクトのメンテナーによって、あなたの PR がレビュー(確認)されます。
ほとんどの場合は 24 時間以内にレビューしますが、数日の遅れが発生することもあります。気長にお待ちください ☕
お疲れ様です!
そして First Contributions JA に、時間と労力を割いて貢献していただきありがとうございます!!
Important
もしこのプロジェクトが役に立つと思った場合は、ページの上部から star ボタンを押してください!
また、このプロジェクトを広めるために、フォロワーや知り合いに共有してください!
あなたは、オープンソースのプロジェクトに貢献する方法を学びました!
より多くの貢献がしたい方は、貢献ガイドラインを参照してください!
コードの追加やバグの修正、ドキュメントの改善など、どんな些細な貢献も大歓迎です ?
このプロジェクトは、MIT LICENSEの下でライセンスされています。
このプロジェクトは、first-contributionsやContribute-To-This-Projectなどの、
初心者向けに設計された素晴らしいオープンソースプロジェクトから影響を受けています。