Skip to content

Commit 4f2cecf

Browse files
author
Abdullah Khawer
committed
docs: Update README with new chat modes and improve content
1 parent b562557 commit 4f2cecf

File tree

1 file changed

+87
-13
lines changed

1 file changed

+87
-13
lines changed

README.md

Lines changed: 87 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@ A curated collection of custom chat modes based on `chatmode.md` files for Visua
88

99
Custom chat modes allow you to modify GitHub Copilot's behavior in VS Code. Each `chatMode.md` file builds a specialized AI assistant with targeted knowledge and abilities for your development work, significantly cutting development time by eliminating repetitive manual tasks.
1010

11-
## Official Documentation
11+
# Official Documentation
1212

1313
- [GitHub Copilot Chat](https://code.visualstudio.com/docs/copilot/chat/copilot-chat)
1414
- [Custom Chat Modes](https://code.visualstudio.com/docs/copilot/chat/chat-modes#_custom-chat-modes)
1515

16-
## Getting Started
16+
# Getting Started
1717

1818
To use any of these custom chat modes:
1919

@@ -24,13 +24,15 @@ To use any of these custom chat modes:
2424

2525
The chat mode will now be active, and Copilot Chat will respond according to the instructions defined in the chosen `.chatmode.md` file.
2626

27-
## 🧩 Available Chat Modes
27+
# 🚀 Available Chat Modes
2828

2929
| Title | Description | Category |
3030
| ----- | ----------- | -------- |
3131
| [Terraform Helm Release Upgrade Analyser](chat-modes/terraform-helm-release-upgrade-analyser.chatmode.md) | Creates a detailed upgrade plan for a Helm release created via Terraform by analysing the configuration differences between the current and desired Helm chart versions and any breaking changes | Infrastructure & DevOps |
32+
| [Dockerfile Developer](chat-modes/dockerfile-developer.chatmode.md) | Develops optimized, secure, and best-practice Dockerfiles based on user requirements and application context | Infrastructure & DevOps |
33+
| [Conversation to Chat Mode](chat-modes/conversation-to-chat-mode.chatmode.md) | Creates a custom chat mode file based on a conversational interface where users describe their specific task requirements and guidelines | Development Tools |
3234

33-
### 🚀 Featured Chat Mode: Terraform Helm Release Upgrade Analyser
35+
## Terraform Helm Release Upgrade Analyser
3436

3537
This chat mode helps you safely upgrade Helm releases managed by Terraform by:
3638

@@ -39,33 +41,104 @@ This chat mode helps you safely upgrade Helm releases managed by Terraform by:
3941
- **Breaking Change Analysis**: Identifies potential breaking changes and compatibility issues
4042
- **Detailed Planning**: Creates comprehensive upgrade plans with step-by-step instructions
4143

42-
#### Demo
44+
### Demo
4345

4446
![Demo](demos/terraform-helm-release-upgrade-analyser.chatmode.gif)
4547

46-
#### Example Usage
48+
### Example Usage
4749

4850
To use this chat mode effectively, follow these steps:
4951

50-
##### Prerequisites
52+
### Prerequisites
53+
5154
1. Ensure you have Terraform code that contains a Helm release resource
5255
2. Know the current and desired Helm chart versions for your upgrade
5356

54-
##### Setup
57+
### Setup
58+
5559
1. Start a new chat session
5660
2. Select `terraform-helm-release-upgrade-analyser.chatmode.md` as the chat mode
5761
3. Select `Claude Sonnet 4` as the model
5862
4. Choose the directory containing your Terraform code for the Helm release as the context
5963

60-
##### Prompt Example
64+
### Prompt Example
6165

6266
```
6367
Analyze my Helm chart upgrade plan.
6468
Current Helm chart version: 4.12.3
6569
Desired Helm chart version: 4.13.1
6670
```
6771

68-
## 🤝 Contributing
72+
## Dockerfile Developer
73+
74+
This chat mode helps you create optimized, secure, and production-ready Dockerfiles by:
75+
76+
- **Context Analysis**: Analyzes your project files to understand dependencies and build requirements
77+
- **Best Practices**: Follows Docker best practices including proper layer ordering, caching optimization, and clean syntax
78+
- **Size Optimization**: Creates minimal container images through multi-stage builds and efficient package management
79+
- **Security Focus**: Implements security best practices including non-root users and vulnerability scanning
80+
- **Technology Detection**: Automatically detects your application stack from project files (package.json, requirements.txt, etc.)
81+
82+
### Demo
83+
84+
![Demo](demos/dockerfile-developer.chatmode.gif)
85+
86+
### Example Usage
87+
88+
To use this chat mode effectively, follow these steps:
89+
90+
### Prerequisites
91+
- Have your application project ready in a specific directory
92+
- Know your application type and technology stack
93+
- Have access to dependency files if they exist
94+
95+
### Setup
96+
1. Start a new chat session
97+
2. Select `dockerfile-developer.chatmode.md` as the chat mode
98+
3. Select `Claude Sonnet 4` as the model
99+
4. Have your application details and project context ready
100+
101+
### Prompt Example
102+
103+
```
104+
I need to create a Dockerfile for my Node.js application. Please help me develop an optimized Dockerfile.
105+
```
106+
107+
## Conversation to Chat Mode
108+
109+
This meta chat mode helps you create new custom chat modes through a guided conversation by:
110+
111+
- **Interactive Creation**: Walks you through a conversational interface to define your chat mode requirements
112+
- **Template Generation**: Automatically generates properly formatted `.chatmode.md` files based on your inputs
113+
- **Guided Questions**: Asks targeted questions about your specific task and required guidelines
114+
- **Best Practices**: Ensures your custom chat mode follows established conventions and formatting
115+
116+
### Demo
117+
118+
![Demo](demos/conversation-to-chat-mode.chatmode.gif)
119+
120+
### Example Usage
121+
122+
To use this chat mode effectively, follow these steps:
123+
124+
### Prerequisites
125+
126+
1. Have a clear idea of what specific task or problem you want your custom chat mode to solve
127+
2. Think about the specific instructions and guidelines needed for that task
128+
129+
### Setup
130+
131+
1. Start a new chat session
132+
2. Select `conversation-to-chat-mode.chatmode.md` as the chat mode
133+
3. Select `Claude Sonnet 4` as the model
134+
135+
### Prompt Example
136+
137+
```
138+
Let's have a conversation to build a custom chat mode file.
139+
```
140+
141+
# 🤝 Contributing
69142

70143
Contributions are welcome! If you have a custom chat mode you'd like to share:
71144

@@ -74,18 +147,19 @@ Contributions are welcome! If you have a custom chat mode you'd like to share:
74147
3. Update this README.md to include your chat mode in the table
75148
4. Submit a pull request
76149

77-
### Chat Mode Guidelines
150+
# Chat Mode Guidelines
78151

79152
- Use descriptive names and clear descriptions
80153
- Include comprehensive documentation and usage examples
81154
- Test your chat mode thoroughly before submitting
82155
- Follow the established file naming convention: `your-mode-name.chatmode.md`
83156

84-
## 📝 License
157+
# 📝 License
85158

86159
This project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details.
87160

88161
---
89162

90163
###### 😊 Any contributions, improvements and suggestions will be highly appreciated.
91-
###### 🌟 Star the repo now and be the first to know about new and exciting chat modes for VS Code.
164+
165+
###### 🌟 Star this repository to know about awesome new chat modes for VS Code.

0 commit comments

Comments
 (0)