Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Co-authored-by: ToYama170402 <100946113+ToYama170402@users.noreply.github.com>
ToYama170402
left a comment
There was a problem hiding this comment.
CONTRIBUTING_BEGINERS.mdにて、初心者にツールやサービス、ライブラリなどの公式ドキュメントに当たる癖をつけてほしいので、公式ドキュメントに誘導してほしいです。
貢献はコードを書くことだけではないので、その点を踏まえた追記をお願いしたいです。
それから、git操作について、コマンドだけではなくでVSCodeでのやり方をメインに据えて、コマンド操作は補助として記述してください。そっちのほうが頻繁に使う上に気軽にコミットできるからです。
CONTRIBUTING_BEGINNERS.md
Outdated
| - このボタンをクリック | ||
| - メニューから「Reopen in Container」を選択 | ||
| - 開発したいサービスを選択(例: `frontend`、`syllabus-frontend`など) | ||
| - 初回は環境構築に時間がかかります(数分〜10分程度) |
There was a problem hiding this comment.
通信環境によってはもっと時間がかかる(30分程度まで)ことがあります。
|
@copilot |
Co-authored-by: ToYama170402 <100946113+ToYama170402@users.noreply.github.com>
すべてのご指摘に対応しました。(a5f37d0) 主な変更点:
|
ToYama170402
left a comment
There was a problem hiding this comment.
修正ありがとうございます。
以下、全体を通して気になった点・要望を列挙します。
- GitとGitHubの違いと関係を説明したほうがいいんじゃないかと思う
- Issueの書き方にも言及したい
- GitHubの各機能の紹介でより詳しく知りたい人のために公式ドキュメントへのリンクを載せたい
- このドキュメントで紹介されているGit操作はすべてVS Codeでできるので、VS Codeでのやり方も載せたい
CONTRIBUTING_BEGINNERS.md
Outdated
| - **説明**: 詳しい内容を書く | ||
| - 何をしたか | ||
| - なぜその変更が必要か | ||
| - 関連するIssue(あれば): `#123` のように書く |
There was a problem hiding this comment.
Pull Requestテンプレートに従って記入するよう誘導を追加しました。テンプレートの重要性とレビュワーが理解しやすくなる理由も明記しました。(c4130b0)
There was a problem hiding this comment.
PRテンプレートに従うよう誘導を追加しました。テンプレートの存在を明記し、各項目(変更内容、変更の種類、関連Issue、テストなど)の説明も追加しています。(c4130b0)
|
@copilot |
Co-authored-by: ToYama170402 <100946113+ToYama170402@users.noreply.github.com>
すべてのご要望に対応しました。(c4130b0) 対応内容:
|
Co-authored-by: ToYama170402 <100946113+ToYama170402@users.noreply.github.com>
すべてのご要望に対応しました。(c4130b0, dbe2b3d) 実装した内容:
|
ToYama170402
left a comment
There was a problem hiding this comment.
@copilot
全体的に良いです。
コメントした点を修正お願いします
Co-authored-by: ToYama170402 <100946113+ToYama170402@users.noreply.github.com>
ToYama170402
left a comment
There was a problem hiding this comment.
@copilot
全体的に良いと思います。
実際に初心者に見せてわからないところがあったらまた追記してもらうかもしれないです。
変更内容
GitHub未経験者向けの包括的な貢献ガイド(
CONTRIBUTING_BEGINNERS.md)を新規作成。アカウント作成から環境構築、PR作成までの全フローを日本語で解説。GitとGitHubの違いを明確に説明し、公式ドキュメントへの誘導を強化。すべてのGit操作をVS Code GUIで実行できるよう記載し、Issue/PRの書き方でテンプレート活用を強調。重複Issue防止のため既存Issue検索を促し、専門用語(ディレクトリ等)に説明を追加。変更の種類
関連Issue
Closes #148
変更の詳細
新規作成:
CONTRIBUTING_BEGINNERS.md(約755行)更新:
CONTRIBUTING.md冒頭に初心者ガイドへの誘導リンクを追加
更新:
readme.mdコントリビュートセクションに初心者/経験者向けガイドの区別を明示
レビューフィードバック対応(1回目)
レビューフィードバック対応(2回目)
レビューフィードバック対応(3回目)
テスト
テスト内容
チェックリスト
その他
画像は含まれていませんが、テキストのみで各画面の機能を理解できるよう記述しています。初心者が公式ドキュメントに当たる習慣をつけられるよう、すべての主要ツールと概念に公式ドキュメントへのリンク(15個以上)を追加しました。また、すべてのGit操作をVS Code GUIで実行できるよう、コマンドパレットやソース管理パネルを使った方法を詳しく説明し、コマンドラインは補助として記載することで、初心者が気軽にGit操作を行えるようにしています。Issue/PRの作成時にはテンプレートに従うことの重要性を繰り返し強調し、円滑な貢献を促進します。さらに、重複Issueを防ぐため既存Issue検索を促し、専門用語には括弧書きや補足説明を追加することで、初心者がつまずきにくい構成にしています。
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.