mirror of
https://github.com/github/awesome-copilot.git
synced 2026-02-22 11:25:13 +00:00
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 <6563688+anchildress1@users.noreply.github.com> * 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 <6563688+anchildress1@users.noreply.github.com> --------- Signed-off-by: Ashley Childress <6563688+anchildress1@users.noreply.github.com>
This commit is contained in:
@@ -13,7 +13,8 @@ Instructions help customize GitHub Copilot's behavior for specific technologies,
|
||||
3. **Structure your content**: Start with a clear heading and organize your instructions logically
|
||||
4. **Test your instructions**: Make sure your instructions work well with GitHub Copilot
|
||||
|
||||
#### Example instruction format:
|
||||
#### Example instruction format
|
||||
|
||||
```markdown
|
||||
---
|
||||
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.
|
||||
3. **Include frontmatter**: Add metadata at the top of your file (optional but recommended)
|
||||
4. **Structure your prompt**: Provide clear context and specific instructions
|
||||
|
||||
#### Example prompt format:
|
||||
#### Example prompt format
|
||||
|
||||
```markdown
|
||||
---
|
||||
mode: 'agent'
|
||||
@@ -69,7 +71,8 @@ Chat modes are specialized configurations that transform GitHub Copilot Chat int
|
||||
4. **Define the persona**: Create a clear identity and expertise area for the chat mode
|
||||
5. **Test your chat mode**: Ensure the chat mode provides helpful, accurate responses in its domain
|
||||
|
||||
#### Example chat mode format:
|
||||
#### Example chat mode format
|
||||
|
||||
```markdown
|
||||
---
|
||||
description: 'Brief description of the chat mode and its purpose'
|
||||
@@ -109,7 +112,8 @@ Collections group related prompts, instructions, and chat modes around specific
|
||||
3. **Reference existing items**: Collections should only reference files that already exist in the repository
|
||||
4. **Test your collection**: Verify all referenced files exist and work well together
|
||||
|
||||
#### Creating a collection:
|
||||
#### Creating a collection
|
||||
|
||||
```bash
|
||||
# Using the creation script
|
||||
node create-collection.js my-collection-id
|
||||
@@ -117,7 +121,8 @@ node create-collection.js my-collection-id
|
||||
# Or using VS Code Task: Ctrl+Shift+P > "Tasks: Run Task" > "create-collection"
|
||||
```
|
||||
|
||||
#### Example collection format:
|
||||
#### Example collection format
|
||||
|
||||
```yaml
|
||||
id: my-collection-id
|
||||
name: My Collection Name
|
||||
@@ -135,7 +140,8 @@ display:
|
||||
show_badge: false # set to true to show collection badge
|
||||
```
|
||||
|
||||
#### Collection Guidelines:
|
||||
#### Collection Guidelines
|
||||
|
||||
- **Focus on workflows**: Group items that work together for specific use cases
|
||||
- **Reasonable size**: Typically 3-10 items work well
|
||||
- **Test combinations**: Ensure the items complement each other effectively
|
||||
@@ -155,7 +161,7 @@ display:
|
||||
- A brief description of what your instruction/prompt does
|
||||
- Any relevant context or usage notes
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
## What We Accept
|
||||
|
||||
@@ -194,6 +200,7 @@ To maintain a safe, responsible, and constructive community, we will **not accep
|
||||
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!
|
||||
|
||||
We welcome contributions of all types, including:
|
||||
|
||||
- 📝 Documentation improvements
|
||||
- 💻 Code contributions
|
||||
- 🐛 Bug reports and fixes
|
||||
|
||||
Reference in New Issue
Block a user