CONTRIBUTING.md

Important

このガイドは、オープンソースプロジェクトへの初めての貢献を体験するチュートリアルではありません。
チュートリアルを完了し、より多くの貢献をしたい方や、メンテナー向けに書かれたガイドです！

first-contributions-ja への貢献ガイド

first-contributions-ja への貢献（コントリビューション）を始めるには、下記のガイドを参照してください。

このプロジェクトをより良いものにしていくために、
様々な開発者とコラボレーションしながら、1 つでも多くのコミットを積み上げることが楽しみです！ 👋

目次

• first-contributions-ja について
• どんな貢献をすればいいですか？
• 開発の流れ
• スタイルガイドライン
  • Commit Message
  • Branch
  • Pull Request

first-contributions-ja について

このプロジェクトは、主に Git/Github の学習を始めたばかりの方や、初めてオープンソースプロジェクトに貢献したい方を対象としています。

なので、ポップな Web サイトと、明確なチュートリアル、そして初心者に対して協力的なコミュニティが必要です。

チュートリアルを、より分かりやすくするアイデアはありますか？
Web サイトには、どのような機能・コンテンツが必要でしょうか？

全てのコントリビューターを、スキルレベルに関係なく、オープンソースに貢献したい 1 人の開発者として歓迎します 🙌

協力的で楽しい環境を維持するために、
まず、会話から始めましょう！

• Issues: 機能追加やバグ修正に関する問題（タスク）を扱う場所
• Discussions: チュートリアルのサポート、このプロジェクトに関するメモ、疑問やアイデアの共有などカジュアルな議論を行う場所

どんな貢献をすればいいですか？

このプロジェクトに貢献する方法はいくつかあります。

• Issue を開いて、次のような報告をする：
  • コードの修正、ドキュメンテーションの改善、バグ報告
• Issue を開いて、次のような提案をする：
  • 新機能、ドキュメントに対する新しい項目の追加
• 未解決の Issue に着手する

Issue には、用意されたテンプレートを利用できます！

開発の流れ

実際に開発に参加する流れは、以下の通りです！

基本的には、チュートリアルの流れと同じですが、
「作業する Issue を見つける」項目が追加されていることに注意してください 📝

• Step 0: 作業する Issue を見つける
• Step 1: このリポジトリをフォーク
• Step 2: ローカルマシンへクローン
• Step 3: 作業用ブランチを作成
• Step 4: 変更を加える
• Step 5: 変更をコミット
• Step 6: 変更をプッシュ
• Step 7: プルリクエスト（PR）を作成
• Step 8: レビューとフィードバックに対応
• Finish: 🎉

Step 0: 作業する Issue を見つける

チュートリアルでは、以下のタスクを行いました：

このプロジェクトの参加者として、Contributors.json ファイルに必要な情報を入力し、プロフィールカードを作成

同じように、まず初めに取り組むべき Issue を見つけます。

その際、次のことに注意してください：

• Assigneesが設定されている場合、そのタスクは既に他の開発者に割り当てられています。
• もし、Assigneesに誰も割り当てられていない場合は、Issue 内にコメントをして、割り当てられてからタスクに着手してください。
• これによって、特定の Issue に取り組んでいる人が明確になり、複数人が同じ作業を行なってしまうことを防げます。

スタイルガイドライン

基本的には、以下のスタイルガイドラインに合わせてください！
そこまで厳格ではないですよ 🎨

Commit Message

命名規則は、次のとおりです：

• 基本: 絵文字 prefix: 内容 #issue番号
• 例: 📚 docs: README.mdに日本語訳を追加 #12
• prefix に対応した絵文字
  • ✨ feat: 新機能の追加
  • 🐛 fix: バグの修正
  • 📈 improve: 機能追加でもバグ修正でもない、コードの改善
  • 🎨 style: スタイルの追加・修正・削除
  • 📚 docs: ドキュメントの追加・修正・削除
  • 🔧 chore: 雑事、カテゴライズする必要のないもの

手順はこちら：

• git add .
• git commit -m "📚 docs: README.mdに日本語訳を追加 #12"

Branch

ブランチ名は、あなたがこれから行う作業に関連した意味のある名前を付けます。

命名規則は、次のとおりです：

• prefix/簡潔な作業内容-#issue番号-
  • 例: docs/create-documents-#01
• 単語の区切りには 「-」を使いましょう。
• prefixに関しては、コミットメッセージを参考にしてください

手順はこちら：

• git branch docs/#17-test
• git branchでブランチが作成されたか確認する
• git checkout docs/#17-testとして branch に移動
• git statusで branch に移動したことを確認

Pull Request

• 作成ルール
  • 基本的に Issue に対してブランチを作成し、プルリクエストを行う
• 作成手順
  • プルリクエスト作成画面の URL 末尾に、以下の URL を追加することで、テンプレートを利用できます

    ?quick_pull=1&template=pr.md

  • プルリク画面 URL
    • https://github.com/first-contributions-ja/first-contributions-ja.github.io/compare/main...branchname
  • テンプレートを追加した URL
    • https://github.com/first-contributions-ja/first-contributions-ja.github.io/compare/main...branchname?quick_pull=1&template=pr.md

最新の main ブランチを取得、反映

• git checkout main で main ブランチに移動
• git statusで状況を把握
• git pull origin main
• ref: リモートリポジトリから変更を取得する - GitHub Docs