You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 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]>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+14-7Lines changed: 14 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,7 +13,8 @@ Instructions help customize GitHub Copilot's behavior for specific technologies,
13
13
3.**Structure your content**: Start with a clear heading and organize your instructions logically
14
14
4.**Test your instructions**: Make sure your instructions work well with GitHub Copilot
15
15
16
-
#### Example instruction format:
16
+
#### Example instruction format
17
+
17
18
```markdown
18
19
---
19
20
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.
41
42
3.**Include frontmatter**: Add metadata at the top of your file (optional but recommended)
42
43
4.**Structure your prompt**: Provide clear context and specific instructions
43
44
44
-
#### Example prompt format:
45
+
#### Example prompt format
46
+
45
47
```markdown
46
48
---
47
49
mode: 'agent'
@@ -69,7 +71,8 @@ Chat modes are specialized configurations that transform GitHub Copilot Chat int
69
71
4.**Define the persona**: Create a clear identity and expertise area for the chat mode
70
72
5.**Test your chat mode**: Ensure the chat mode provides helpful, accurate responses in its domain
71
73
72
-
#### Example chat mode format:
74
+
#### Example chat mode format
75
+
73
76
```markdown
74
77
---
75
78
description: 'Brief description of the chat mode and its purpose'
@@ -109,15 +112,17 @@ Collections group related prompts, instructions, and chat modes around specific
109
112
3.**Reference existing items**: Collections should only reference files that already exist in the repository
110
113
4.**Test your collection**: Verify all referenced files exist and work well together
111
114
112
-
#### Creating a collection:
115
+
#### Creating a collection
116
+
113
117
```bash
114
118
# Using the creation script
115
119
node create-collection.js my-collection-id
116
120
117
121
# Or using VS Code Task: Ctrl+Shift+P > "Tasks: Run Task" > "create-collection"
118
122
```
119
123
120
-
#### Example collection format:
124
+
#### Example collection format
125
+
121
126
```yaml
122
127
id: my-collection-id
123
128
name: My Collection Name
@@ -135,7 +140,8 @@ display:
135
140
show_badge: false # set to true to show collection badge
136
141
```
137
142
138
-
#### Collection Guidelines:
143
+
#### Collection Guidelines
144
+
139
145
- **Focus on workflows**: Group items that work together for specific use cases
140
146
- **Reasonable size**: Typically 3-10 items work well
141
147
- **Test combinations**: Ensure the items complement each other effectively
@@ -155,7 +161,7 @@ display:
155
161
- A brief description of what your instruction/prompt does
156
162
- Any relevant context or usage notes
157
163
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.
159
165
160
166
## What We Accept
161
167
@@ -194,6 +200,7 @@ To maintain a safe, responsible, and constructive community, we will **not accep
194
200
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!
Copy file name to clipboardExpand all lines: README.chatmodes.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,6 +40,7 @@ Custom chat modes define specific behaviors and tools for GitHub Copilot Chat, e
40
40
|[Expert C++ software engineer mode instructions](chatmodes/expert-cpp-software-engineer.chatmode.md)<br />[](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 />[](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. |
41
41
|[Expert React Frontend Engineer Mode Instructions](chatmodes/expert-react-frontend-engineer.chatmode.md)<br />[](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 />[](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. |
42
42
|[Gilfoyle Code Review Mode](chatmodes/gilfoyle.chatmode.md)<br />[](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 />[](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 />[](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 />[](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. |
43
44
|[Idea Generator mode instructions](chatmodes/simple-app-idea-generator.chatmode.md)<br />[](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 />[](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. |
44
45
|[Implementation Plan Generation Mode](chatmodes/implementation-plan.chatmode.md)<br />[](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 />[](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. |
45
46
|[Kusto Assistant: Azure Data Explorer (Kusto) Engineering Assistant](chatmodes/kusto-assistant.chatmode.md)<br />[](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 />[](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 |
Copy file name to clipboardExpand all lines: README.md
+8-2Lines changed: 8 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,33 +47,39 @@ To make it easy to add these customizations to your editor, we have created a [M
47
47
## 🔧 How to Use
48
48
49
49
### 🎯 Prompts
50
+
50
51
Use the `/` command in GitHub Copilot Chat to access prompts:
51
-
```
52
+
53
+
```plaintext
52
54
/awesome-copilot create-readme
53
55
```
54
56
55
57
### 📋 Instructions
58
+
56
59
Instructions automatically apply to files based on their patterns and provide contextual guidance for coding standards, frameworks, and best practices.
57
60
58
61
### 💭 Chat Modes
62
+
59
63
Activate chat modes to get specialized assistance from AI personas tailored for specific roles like architects, DBAs, or security experts.
60
64
61
65
## 🤝 Contributing
62
66
63
67
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to:
68
+
64
69
- Add new prompts, instructions, or chat modes
65
70
- Improve existing content
66
71
- Report issues or suggest enhancements
67
72
68
73
### Quick Contribution Guide
74
+
69
75
1. Follow our file naming conventions and frontmatter requirements
70
76
2. Test your contributions thoroughly
71
77
3. Update the appropriate README tables
72
78
4. Submit a pull request with a clear description
73
79
74
80
## 📖 Repository Structure
75
81
76
-
```
82
+
```plaintext
77
83
├── prompts/ # Task-specific prompts (.prompt.md)
78
84
├── instructions/ # Coding standards and best practices (.instructions.md)
79
85
├── chatmodes/ # AI personas and specialized modes (.chatmode.md)
0 commit comments