176 lines
9.1 KiB
Markdown
176 lines
9.1 KiB
Markdown
# Awesome GitHub Copilot への貢献
|
||
|
||
Awesome GitHub Copilot リポジトリへの貢献にご関心をお寄せいただき、ありがとうございます！カスタム指示とプロンプトのコレクションを拡大するために、コミュニティからの貢献を歓迎しています。
|
||
|
||
## 貢献方法
|
||
|
||
### 指示の追加
|
||
|
||
指示は、特定の技術、コーディング実践、またはドメインに対して GitHub Copilot の動作をカスタマイズするのに役立ちます。
|
||
|
||
1. **指示ファイルの作成**: `instructions/` ディレクトリに新しい `.md` ファイルを追加します
|
||
2. **命名規則に従う**: ハイフンで区切られた説明的な小文字のファイル名を使用してください（例：`python-django.instructions.md`）
|
||
3. **コンテンツを構造化する**: 明確な見出しで始まり、指示を論理的に整理します
|
||
4. **指示をテストする**: 指示が GitHub Copilot でうまく動作することを確認してください
|
||
|
||
#### 指示フォーマットの例
|
||
|
||
```markdown
|
||
---
|
||
description: '特定の技術と実践に対するGitHub Copilotの動作をカスタマイズする指示'
|
||
---
|
||
|
||
# あなたの技術/フレームワーク名
|
||
|
||
## 指示
|
||
|
||
- GitHub Copilot に明確で具体的なガイダンスを提供
|
||
- ベストプラクティスと規約を含める
|
||
- 読みやすくするために箇条書きを使用
|
||
|
||
## 追加ガイドライン
|
||
|
||
- 追加のコンテキストや例
|
||
```
|
||
|
||
### プロンプトの追加
|
||
|
||
プロンプトは、特定の開発シナリオやタスクに対してすぐに使用できるテンプレートです。
|
||
|
||
1. **プロンプトファイルの作成**: `prompts/` ディレクトリに新しい `.prompt.md` ファイルを追加します
|
||
2. **命名規則に従う**: ハイフンと `.prompt.md` 拡張子を使用した説明的な小文字のファイル名を使用してください（例：`react-component-generator.prompt.md`）
|
||
3. **フロントマターを含める**: ファイルの先頭にメタデータを追加してください（オプションですが推奨されます）
|
||
4. **プロンプトを構造化する**: 明確なコンテキストと具体的な指示を提供してください
|
||
|
||
#### プロンプトフォーマットの例
|
||
|
||
```markdown
|
||
---
|
||
mode: 'agent'
|
||
tools: ['codebase', 'terminalCommand']
|
||
description: 'このプロンプトが何をするかの簡潔な説明'
|
||
---
|
||
|
||
# プロンプトタイトル
|
||
|
||
あなたの目標は...
|
||
|
||
## 具体的な指示
|
||
|
||
- 明確で実行可能な指示
|
||
- 役立つ場合は例を含める
|
||
```
|
||
|
||
### チャットモードの追加
|
||
|
||
チャットモードは、GitHub Copilot Chat を特定の開発シナリオ向けのドメイン固有のアシスタントやペルソナに変換する特化した設定です。
|
||
|
||
1. **チャットモードファイルの作成**: `chatmodes/` ディレクトリに新しい `.chatmode.md` ファイルを追加します
|
||
2. **命名規則に従う**: ハイフンと `.chatmode.md` 拡張子を使用した説明的な小文字のファイル名を使用してください（例：`react-performance-expert.chatmode.md`）
|
||
3. **フロントマターを含める**: 必須フィールドと共にファイルの先頭にメタデータを追加してください
|
||
4. **ペルソナを定義する**: チャットモードの明確なアイデンティティと専門分野を作成してください
|
||
5. **チャットモードをテストする**: チャットモードがそのドメインで有用で正確な応答を提供することを確認してください
|
||
|
||
#### チャットモードフォーマットの例
|
||
|
||
```markdown
|
||
---
|
||
description: 'チャットモードとその目的の簡潔な説明'
|
||
model: 'gpt-5'
|
||
tools: ['codebase', 'terminalCommand']
|
||
---
|
||
|
||
# チャットモードタイトル
|
||
|
||
あなたは[特定の分野]に深い知識を持つ専門的な[ドメイン/役割]です。
|
||
|
||
## あなたの専門知識
|
||
|
||
- [具体的なスキル1]
|
||
- [具体的なスキル2]
|
||
- [具体的なスキル3]
|
||
|
||
## あなたのアプローチ
|
||
|
||
- [ユーザーを支援する方法]
|
||
- [あなたのコミュニケーションスタイル]
|
||
- [あなたが優先すること]
|
||
|
||
## ガイドライン
|
||
|
||
- [応答に関する具体的な指示]
|
||
- [制約や制限]
|
||
- [従うべきベストプラクティス]
|
||
```
|
||
|
||
## 貢献の提出
|
||
|
||
1. **このリポジトリをフォークする**
|
||
2. **新しいブランチを作成する**（あなたの貢献用に）
|
||
3. **上記のガイドラインに従って指示またはプロンプトファイルを追加する**
|
||
4. **更新スクリプトを実行する**（オプション）：`node update-readme.js` を実行して新しいファイルでREADMEを更新
|
||
- GitHub Actions ワークフローがこのステップが正しく実行されたことを検証します
|
||
- スクリプトを実行することでREADME.mdが変更される場合、PRチェックは必要な変更を示すコメントと共に失敗します
|
||
5. **以下の内容でプルリクエストを提出する**:
|
||
- あなたの貢献を説明する明確なタイトル
|
||
- あなたの指示/プロンプトが何をするかの簡潔な説明
|
||
- 関連するコンテキストや使用上の注意
|
||
|
||
**注意**: あなたの貢献がマージされると、自動的に[コントリビューター](#contributors-)セクションに追加されます！プロジェクトへのあらゆる種類の貢献を認識するために[all-contributors](https://github.com/all-contributors/all-contributors)を使用しています。
|
||
|
||
## 受け入れるもの
|
||
|
||
開発者がGitHub Copilotとより効果的に作業することを支援する任意の技術、フレームワーク、または開発実践をカバーする貢献を歓迎しています。これには以下が含まれます：
|
||
|
||
- プログラミング言語とフレームワーク
|
||
- 開発方法論とベストプラクティス
|
||
- アーキテクチャパターンと設計原則
|
||
- テスト戦略と品質保証
|
||
- DevOpsとデプロイメント実践
|
||
- アクセシビリティとインクルーシブデザイン
|
||
- パフォーマンス最適化技術
|
||
|
||
## 受け入れないもの
|
||
|
||
安全で責任があり建設的なコミュニティを維持するため、以下の貢献は**受け入れません**：
|
||
|
||
- **責任あるAI原則に違反するもの**: Microsoft/GitHubの責任あるAIガイドラインを回避したり、有害なAI使用を促進するコンテンツ
|
||
- **セキュリティを損なうもの**: セキュリティポリシーを回避したり、脆弱性を悪用したり、システムセキュリティを弱めることを意図した指示
|
||
- **悪意ある活動を可能にするもの**: 他のシステム、ユーザー、または組織に害を与えることを意図したコンテンツ
|
||
- **弱点を悪用するもの**: 他のプラットフォームやサービスの脆弱性を利用する指示
|
||
- **有害なコンテンツを促進するもの**: 有害で差別的または不適切なコンテンツの作成につながる可能性のあるガイダンス
|
||
- **プラットフォームポリシーを回避するもの**: GitHub、Microsoft、またはその他のプラットフォームの利用規約を回避しようとする試み
|
||
|
||
## 品質ガイドライン
|
||
|
||
- **具体的であること**: 一般的な指示より、具体的で実行可能なガイダンスの方が有用です
|
||
- **コンテンツをテストする**: 指示やプロンプトがGitHub Copilotでうまく動作することを確認してください
|
||
- **規約に従う**: 一貫したフォーマットと命名を使用してください
|
||
- **焦点を保つ**: 各ファイルは特定の技術、フレームワーク、またはユースケースに対処する必要があります
|
||
- **明確に書く**: シンプルで直接的な言語を使用してください
|
||
- **ベストプラクティスを促進する**: 安全で保守可能で倫理的な開発実践を奨励してください
|
||
|
||
## コントリビューター認識
|
||
|
||
このプロジェクトは、コントリビューターを認識するために[all-contributors](https://github.com/all-contributors/all-contributors)を使用しています。貢献をすると、自動的にコントリビューターリストで認識されます！
|
||
|
||
以下を含むあらゆる種類の貢献を歓迎しています：
|
||
|
||
- 📝 ドキュメントの改善
|
||
- 💻 コードの貢献
|
||
- 🐛 バグレポートと修正
|
||
- 🎨 デザインの改善
|
||
- 💡 アイデアと提案
|
||
- 🤔 質問への回答
|
||
- 📢 プロジェクトのプロモーション
|
||
|
||
あなたの貢献は、GitHub Copilotコミュニティ全体のためにこのリソースをより良くするのに役立ちます！
|
||
|
||
## 行動規範
|
||
|
||
このプロジェクトは[コントリビューター行動規範](CODE_OF_CONDUCT.md)とともにリリースされていることにご注意ください。このプロジェクトに参加することで、その条件に従うことに同意したものとみなされます。
|
||
|
||
## ライセンス
|
||
|
||
このリポジトリに貢献することで、あなたの貢献がMITライセンスの下でライセンスされることに同意したものとみなされます。
|