Skip to content

Commit 383c9be

Browse files
authored
feat(chatmodes): Add HLBPA (documentation architect) chat mode (#278)
* feat(chatmodes): Add HLBPA (documentation architect) chat modes - HLBPA is a high-level, big-picture architect for systems documentation - It can be used either in VSC as usual or dropped in coding agent for auto-updates - Depends on user's prompting skills to get the best results - Will default to a more generalist mode if not enough context is given - Minor updates to README and CONTRIBUTING to fix formatting errors Assisted-by: GitHub Copilot & Verdent AI Signed-off-by: Ashley Childress <[email protected]> * chore(chatmodes): Remove copy from md fence in HLBPA chat mode - Copilot complains about the copy in the md fence - Isn't likely to be used in this context anyway Assisted-by: GitHub Copilot Signed-off-by: Ashley Childress <[email protected]> --------- Signed-off-by: Ashley Childress <[email protected]>
1 parent 3980e6b commit 383c9be

File tree

5 files changed

+254
-9
lines changed

5 files changed

+254
-9
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ Copilot-Processing.md
44

55
# macOS system files
66
.DS_Store
7+
*.tmp

CONTRIBUTING.md

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@ Instructions help customize GitHub Copilot's behavior for specific technologies,
1313
3. **Structure your content**: Start with a clear heading and organize your instructions logically
1414
4. **Test your instructions**: Make sure your instructions work well with GitHub Copilot
1515

16-
#### Example instruction format:
16+
#### Example instruction format
17+
1718
```markdown
1819
---
1920
description: 'Instructions for customizing GitHub Copilot behavior for specific technologies and practices'
@@ -41,7 +42,8 @@ Prompts are ready-to-use templates for specific development scenarios and tasks.
4142
3. **Include frontmatter**: Add metadata at the top of your file (optional but recommended)
4243
4. **Structure your prompt**: Provide clear context and specific instructions
4344

44-
#### Example prompt format:
45+
#### Example prompt format
46+
4547
```markdown
4648
---
4749
mode: 'agent'
@@ -69,7 +71,8 @@ Chat modes are specialized configurations that transform GitHub Copilot Chat int
6971
4. **Define the persona**: Create a clear identity and expertise area for the chat mode
7072
5. **Test your chat mode**: Ensure the chat mode provides helpful, accurate responses in its domain
7173

72-
#### Example chat mode format:
74+
#### Example chat mode format
75+
7376
```markdown
7477
---
7578
description: 'Brief description of the chat mode and its purpose'
@@ -109,15 +112,17 @@ Collections group related prompts, instructions, and chat modes around specific
109112
3. **Reference existing items**: Collections should only reference files that already exist in the repository
110113
4. **Test your collection**: Verify all referenced files exist and work well together
111114

112-
#### Creating a collection:
115+
#### Creating a collection
116+
113117
```bash
114118
# Using the creation script
115119
node create-collection.js my-collection-id
116120

117121
# Or using VS Code Task: Ctrl+Shift+P > "Tasks: Run Task" > "create-collection"
118122
```
119123

120-
#### Example collection format:
124+
#### Example collection format
125+
121126
```yaml
122127
id: my-collection-id
123128
name: My Collection Name
@@ -135,7 +140,8 @@ display:
135140
show_badge: false # set to true to show collection badge
136141
```
137142
138-
#### Collection Guidelines:
143+
#### Collection Guidelines
144+
139145
- **Focus on workflows**: Group items that work together for specific use cases
140146
- **Reasonable size**: Typically 3-10 items work well
141147
- **Test combinations**: Ensure the items complement each other effectively
@@ -155,7 +161,7 @@ display:
155161
- A brief description of what your instruction/prompt does
156162
- Any relevant context or usage notes
157163

158-
**Note**: Once your contribution is merged, you'll automatically be added to our [Contributors](#contributors-) section! We use [all-contributors](https://github.com/all-contributors/all-contributors) to recognize all types of contributions to the project.
164+
**Note**: Once your contribution is merged, you'll automatically be added to our [Contributors](./README.md#contributors-) section! We use [all-contributors](https://github.com/all-contributors/all-contributors) to recognize all types of contributions to the project.
159165

160166
## What We Accept
161167

@@ -194,6 +200,7 @@ To maintain a safe, responsible, and constructive community, we will **not accep
194200
This project uses [all-contributors](https://github.com/all-contributors/all-contributors) to recognize contributors. When you make a contribution, you'll automatically be recognized in our contributors list!
195201

196202
We welcome contributions of all types, including:
203+
197204
- 📝 Documentation improvements
198205
- 💻 Code contributions
199206
- 🐛 Bug reports and fixes

README.chatmodes.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, e
4040
| [Expert C++ software engineer mode instructions](chatmodes/expert-cpp-software-engineer.chatmode.md)<br />[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fexpert-cpp-software-engineer.chatmode.md)<br />[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fexpert-cpp-software-engineer.chatmode.md) | Provide expert C++ software engineering guidance using modern C++ and industry best practices. |
4141
| [Expert React Frontend Engineer Mode Instructions](chatmodes/expert-react-frontend-engineer.chatmode.md)<br />[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fexpert-react-frontend-engineer.chatmode.md)<br />[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fexpert-react-frontend-engineer.chatmode.md) | Provide expert React frontend engineering guidance using modern TypeScript and design patterns. |
4242
| [Gilfoyle Code Review Mode](chatmodes/gilfoyle.chatmode.md)<br />[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fgilfoyle.chatmode.md)<br />[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fgilfoyle.chatmode.md) | Code review and analysis with the sardonic wit and technical elitism of Bertram Gilfoyle from Silicon Valley. Prepare for brutal honesty about your code. |
43+
| [High-Level Big Picture Architect (HLBPA)](chatmodes/hlbpa.chatmode.md)<br />[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fhlbpa.chatmode.md)<br />[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fhlbpa.chatmode.md) | HLBPA: Your perfect AI chat mode for high-level architectural documentation and review. Perfect for targeted updates after a story or researching that legacy system when nobody remembers what it's supposed to be doing. |
4344
| [Idea Generator mode instructions](chatmodes/simple-app-idea-generator.chatmode.md)<br />[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fsimple-app-idea-generator.chatmode.md)<br />[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fsimple-app-idea-generator.chatmode.md) | Brainstorm and develop new application ideas through fun, interactive questioning until ready for specification creation. |
4445
| [Implementation Plan Generation Mode](chatmodes/implementation-plan.chatmode.md)<br />[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fimplementation-plan.chatmode.md)<br />[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fimplementation-plan.chatmode.md) | Generate an implementation plan for new features or refactoring existing code. |
4546
| [Kusto Assistant: Azure Data Explorer (Kusto) Engineering Assistant](chatmodes/kusto-assistant.chatmode.md)<br />[![Install in VS Code](https://img.shields.io/badge/VS_Code-Install-0098FF?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fkusto-assistant.chatmode.md)<br />[![Install in VS Code Insiders](https://img.shields.io/badge/VS_Code_Insiders-Install-24bfa5?style=flat-square&logo=visualstudiocode&logoColor=white)](https://aka.ms/awesome-copilot/install/chatmode?url=vscode-insiders%3Achat-mode%2Finstall%3Furl%3Dhttps%3A%2F%2Fraw.githubusercontent.com%2Fgithub%2Fawesome-copilot%2Fmain%2Fchatmodes%2Fkusto-assistant.chatmode.md) | Expert KQL assistant for live Azure Data Explorer analysis via Azure MCP server |

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,33 +47,39 @@ To make it easy to add these customizations to your editor, we have created a [M
4747
## 🔧 How to Use
4848

4949
### 🎯 Prompts
50+
5051
Use the `/` command in GitHub Copilot Chat to access prompts:
51-
```
52+
53+
```plaintext
5254
/awesome-copilot create-readme
5355
```
5456

5557
### 📋 Instructions
58+
5659
Instructions automatically apply to files based on their patterns and provide contextual guidance for coding standards, frameworks, and best practices.
5760

5861
### 💭 Chat Modes
62+
5963
Activate chat modes to get specialized assistance from AI personas tailored for specific roles like architects, DBAs, or security experts.
6064

6165
## 🤝 Contributing
6266

6367
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to:
68+
6469
- Add new prompts, instructions, or chat modes
6570
- Improve existing content
6671
- Report issues or suggest enhancements
6772

6873
### Quick Contribution Guide
74+
6975
1. Follow our file naming conventions and frontmatter requirements
7076
2. Test your contributions thoroughly
7177
3. Update the appropriate README tables
7278
4. Submit a pull request with a clear description
7379

7480
## 📖 Repository Structure
7581

76-
```
82+
```plaintext
7783
├── prompts/ # Task-specific prompts (.prompt.md)
7884
├── instructions/ # Coding standards and best practices (.instructions.md)
7985
├── chatmodes/ # AI personas and specialized modes (.chatmode.md)

0 commit comments

Comments
 (0)