Skip to content

初心者向け貢献ガイドラインの整備#149

Open
Copilot wants to merge 9 commits intomainfrom
copilot/create-contribution-guide
Open

初心者向け貢献ガイドラインの整備#149
Copilot wants to merge 9 commits intomainfrom
copilot/create-contribution-guide

Conversation

Copy link
Contributor

Copilot AI commented Nov 14, 2025

変更内容

GitHub未経験者向けの包括的な貢献ガイド(CONTRIBUTING_BEGINNERS.md)を新規作成。アカウント作成から環境構築、PR作成までの全フローを日本語で解説。GitとGitHubの違いを明確に説明し、公式ドキュメントへの誘導を強化。すべてのGit操作をVS Code GUIで実行できるよう記載し、Issue/PRの書き方でテンプレート活用を強調。重複Issue防止のため既存Issue検索を促し、専門用語(ディレクトリ等)に説明を追加。

変更の種類

  • ドキュメント更新(Documentation update)

関連Issue

Closes #148

変更の詳細

新規作成: CONTRIBUTING_BEGINNERS.md (約755行)

  • GitとGitHubの違い: 初心者向けに「Gitは道具、GitHubはその道具を使うための場所」という比喩で明確に説明
  • GitHub基礎: GitHubの概念、用語解説(Repository、Issue、Fork、Clone、Branch、Commit、Push、PR、Merge)
  • 公式ドキュメントリンク: すべての主要概念(15個以上)に公式ドキュメントへのリンクを追加
    • GitHub、Git、リポジトリ、Issue、Fork、Clone、Branch、Commit、Pull Request、Merge、VS Code、Docker、Dev Containers、Conventional Commits
  • 貢献の種類: コードを書かない貢献(ドキュメント改善、バグ報告、機能提案など)を明示
  • 画面解説: リポジトリページ、Issue、PRの各タブと機能説明
  • 環境構築: Git、VS Code、Docker、Dev Containersのインストール手順(Windows/Mac/Linux(Arch含む)対応)
  • 5ステップフロー: Fork→環境構築→Issue確認→コード変更→PR作成
  • 完全VS Code GUI操作: すべてのGit操作(ブランチ作成、コミット、プッシュ、upstream追加など)をVS Codeの画面から操作する方法を詳述(コマンドラインは補助として記載)
    • upstream追加: コマンドパレットから「Git: Add Remote」を使用
    • ブランチ作成: 左下のブランチ名から操作
    • コミット・プッシュ: ソース管理パネルから操作
  • Issue/PRの書き方: テンプレートに従うことの重要性を強調
    • Issue作成前の検索: 重複防止のため既存Issueを検索するステップを追加し、検索方法と既存Issueへのコメント参加を案内
    • Issueの書き方: タイトルの良い例・悪い例、具体的な書き方のポイント(再現手順、スクリーンショット、環境情報)
    • PRの書き方: テンプレートの各項目(変更内容、変更の種類、関連Issue、テスト)の説明
  • 用語説明の充実: 初心者にわかりにくい専門用語に説明を追加
    • ディレクトリ: 「ディレクトリ(フォルダ)」と括弧書きで補足し、WindowsとLinux/Macでの呼び方の違いを説明
  • ブランチ命名規則: Conventional Commitsに準拠したフォーマットを含む詳細な規則を追加
  • コミットメッセージフォーマット: typeの種類と記述例を含む詳細な説明を追加
  • サービス別情報: 各サービスのREADMEへのリンクを追加
  • サポート: FAQ、学習リソース、連絡先

更新: CONTRIBUTING.md

冒頭に初心者ガイドへの誘導リンクを追加

更新: readme.md

コントリビュートセクションに初心者/経験者向けガイドの区別を明示

レビューフィードバック対応(1回目)

  • 用語の明確化(エディタ→ソフトウェア、リポ→リポ/レポジトリ、バグ報告→バグ/不具合報告)
  • Issueテンプレート名の修正(実際の名前に合わせて修正)
  • Dev Containerの説明追加
  • 環境構築時間の現実的な見積もりに更新(30分程度まで)
  • 貢献フローの再構成(Issue確認を環境構築後に移動)

レビューフィードバック対応(2回目)

  • GitとGitHubの違いと関係性の説明を追加
  • Issueの書き方を詳細に説明(テンプレート重視、具体的なポイント)
  • 各GitHub機能に公式ドキュメントへのリンクを追加(15個以上)
  • すべてのGit操作にVS Code GUI方法を追加(upstream追加を含む)
  • PRの書き方でテンプレート活用を強調

レビューフィードバック対応(3回目)

  • Issue作成前に既存Issueを検索するステップを追加(重複Issue防止)
  • 「ディレクトリ」用語の説明を追加(フォルダとの関係を明記)

テスト

  • 手動でテスト実施

テスト内容

  • ドキュメントの内容確認
  • リンクの動作確認(すべての公式ドキュメントリンク)
  • マークダウン構文の検証
  • レビューフィードバックへの対応確認
  • VS Code GUI操作手順の確認
  • 用語説明の適切性確認
  • Issue検索ステップの妥当性確認

チェックリスト

  • コードが正常に動作することを確認した
  • ドキュメントを更新した(必要に応じて)
  • 新しい警告が発生していないことを確認した

その他

画像は含まれていませんが、テキストのみで各画面の機能を理解できるよう記述しています。初心者が公式ドキュメントに当たる習慣をつけられるよう、すべての主要ツールと概念に公式ドキュメントへのリンク(15個以上)を追加しました。また、すべてのGit操作をVS Code GUIで実行できるよう、コマンドパレットやソース管理パネルを使った方法を詳しく説明し、コマンドラインは補助として記載することで、初心者が気軽にGit操作を行えるようにしています。Issue/PRの作成時にはテンプレートに従うことの重要性を繰り返し強調し、円滑な貢献を促進します。さらに、重複Issueを防ぐため既存Issue検索を促し、専門用語には括弧書きや補足説明を追加することで、初心者がつまずきにくい構成にしています。

Original prompt

This section details on the original issue you should resolve

<issue_title>初心者向け貢献ガイドラインの整備</issue_title>
<issue_description>- githubの使い方もわからないくらいの初心者を想定

  • githubの画面の解説も含める</issue_description>

<agent_instructions>write in japanese</agent_instructions>

Comments on the Issue (you are @copilot in this section)


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

@vercel
Copy link

vercel bot commented Nov 14, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
rishu-app Error Error Nov 16, 2025 2:13pm

Co-authored-by: ToYama170402 <100946113+ToYama170402@users.noreply.github.com>
Copilot AI changed the title [WIP] 初心者向け貢献ガイドラインを整備 初心者向け貢献ガイドラインの整備 Nov 14, 2025
Copilot AI requested a review from ToYama170402 November 14, 2025 17:24
Copy link
Owner

@ToYama170402 ToYama170402 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CONTRIBUTING_BEGINERS.mdにて、初心者にツールやサービス、ライブラリなどの公式ドキュメントに当たる癖をつけてほしいので、公式ドキュメントに誘導してほしいです。

貢献はコードを書くことだけではないので、その点を踏まえた追記をお願いしたいです。

それから、git操作について、コマンドだけではなくでVSCodeでのやり方をメインに据えて、コマンド操作は補助として記述してください。そっちのほうが頻繁に使う上に気軽にコミットできるからです。

- このボタンをクリック
- メニューから「Reopen in Container」を選択
- 開発したいサービスを選択(例: `frontend`、`syllabus-frontend`など)
- 初回は環境構築に時間がかかります(数分〜10分程度)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

通信環境によってはもっと時間がかかる(30分程度まで)ことがあります。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

「通信環境によって数分〜30分程度」に更新しました。(a5f37d0)

@ToYama170402
Copy link
Owner

@copilot
すみません。メンションをつけるのを忘れておりました。
これまでの指摘を参照して、追加の修正お願いします。

Co-authored-by: ToYama170402 <100946113+ToYama170402@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Nov 16, 2025

CONTRIBUTING_BEGINERS.mdにて、初心者にツールやサービス、ライブラリなどの公式ドキュメントに当たる癖をつけてほしいので、公式ドキュメントに誘導...

すべてのご指摘に対応しました。(a5f37d0)

主な変更点:

  1. 公式ドキュメントへの誘導: GitHub、Git、VS Code、Docker、Dev Containers、Conventional Commitsなど、すべての主要ツールに公式ドキュメントへのリンクを追加しました。
  2. コードを書かない貢献: 冒頭と「貢献の種類」セクションで、ドキュメント改善、バグ報告、機能提案なども立派な貢献であることを明示しました。
  3. VS Code GUI操作をメイン: ブランチ作成、コミット、プッシュなどのGit操作をすべてVS Codeの画面から行う方法を詳しく説明し、コマンドライン操作は「参考」として補助的に記載しました。

Copy link
Owner

@ToYama170402 ToYama170402 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot

修正ありがとうございます。

以下、全体を通して気になった点・要望を列挙します。

  • GitとGitHubの違いと関係を説明したほうがいいんじゃないかと思う
  • Issueの書き方にも言及したい
  • GitHubの各機能の紹介でより詳しく知りたい人のために公式ドキュメントへのリンクを載せたい
  • このドキュメントで紹介されているGit操作はすべてVS Codeでできるので、VS Codeでのやり方も載せたい

Comment on lines 597 to 600
- **説明**: 詳しい内容を書く
- 何をしたか
- なぜその変更が必要か
- 関連するIssue(あれば): `#123` のように書く
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot
テンプレートがあるのでそれに則って書くように誘導したほうがいいんじゃないかと思います。

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Requestテンプレートに従って記入するよう誘導を追加しました。テンプレートの重要性とレビュワーが理解しやすくなる理由も明記しました。(c4130b0)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

PRテンプレートに従うよう誘導を追加しました。テンプレートの存在を明記し、各項目(変更内容、変更の種類、関連Issue、テストなど)の説明も追加しています。(c4130b0)

@ToYama170402
Copy link
Owner

@copilot
コメントしたので修正お願いします 🙇🏻

Co-authored-by: ToYama170402 <100946113+ToYama170402@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Nov 16, 2025

@copilot

修正ありがとうございます。...

すべてのご要望に対応しました。(c4130b0)

対応内容:

  1. GitとGitHubの違い: 「GitHubとは?」セクションに両者の違いと関係性(Gitは道具、GitHubはその道具を使う場所)を追加
  2. Issueの書き方: テンプレート使用の重要性を強調し、書くときのポイント(具体性、再現手順、スクリーンショット、環境情報)を追加
  3. 公式ドキュメントへのリンク: Code、Issues、Pull requests、Actions、Projects、Wiki、Fork、Clone、Branch、Commit、Pull Requestなどすべての機能に公式ドキュメント(日本語)へのリンクを追加
  4. VS Codeでのやり方: upstream追加についてGit Graph拡張機能などの視覚的な管理方法についてNoteを追加(他のGit操作は既にVS Code GUI方式で記載済み)

Co-authored-by: ToYama170402 <100946113+ToYama170402@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Nov 16, 2025

@copilot

修正ありがとうございます。...

すべてのご要望に対応しました。(c4130b0, dbe2b3d)

実装した内容:

  1. GitとGitHubの違い: 「Gitは道具、GitHubはその道具を使うための場所」という比喩で説明を追加
  2. Issueの書き方: テンプレートに従うことの重要性、具体的な書き方のポイント(再現手順、スクリーンショット、環境情報など)を追加
  3. 公式ドキュメントリンク: Repository、Issue、Fork、Clone、Branch、Commit、Pull Request、Mergeなど、各機能にリンクを追加
  4. VS Code GUI操作: upstream追加にコマンドパレット方式を追加し、すべてのGit操作がVS Code GUIで実行可能になりました

Copy link
Owner

@ToYama170402 ToYama170402 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot
全体的に良いです。
コメントした点を修正お願いします

Copy link
Owner

@ToYama170402 ToYama170402 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot
全体的に良いと思います。
実際に初心者に見せてわからないところがあったらまた追記してもらうかもしれないです。

@ToYama170402 ToYama170402 added help wanted Extra attention is needed good first issue Good for newcomers labels Nov 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

good first issue Good for newcomers help wanted Extra attention is needed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

初心者向け貢献ガイドラインの整備

2 participants