Skip to content

Commit 839f876

Browse files
Merge pull request #7 from abdullahkhawer/refinements
docs: Remove redundant setup sections from chat modes and simplify README getting started section, add GitLab fallback for Terraform Helm analyser
2 parents 2f588ca + 5be3f39 commit 839f876

File tree

5 files changed

+2
-49
lines changed

5 files changed

+2
-49
lines changed

README.md

Lines changed: 1 addition & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,17 +13,6 @@ Custom chat modes allow you to modify GitHub Copilot's behavior in VS Code. Each
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
17-
18-
To use any of these custom chat modes:
19-
20-
1. Copy the desired `.chatmode.md` file from the `/chat-modes` directory in this repository to your workspace's `.github/chatmodes` directory (create it if it doesn't exist).
21-
2. Restart VS Code to load the new chat mode.
22-
3. Open the GitHub Copilot Chat panel in VS Code.
23-
4. Click the dropdown menu at the bottom of the chat panel and select your custom chat mode from the list.
24-
25-
The chat mode will now be active, and Copilot Chat will respond according to the instructions defined in the chosen `.chatmode.md` file.
26-
2716
# 🚀 Available Chat Modes
2817

2918
| Title | Description | Category |
@@ -124,7 +113,7 @@ This will prompt the chat mode to guide you through any necessary questions or s
124113
- Be specific about your requirements when the chat mode asks for clarification
125114
- Ensure you have the necessary permissions and prerequisites before starting
126115

127-
**Note: For more details about usage around prerequisites, setup and prompt examples, refer to the chosen custom chat mode's `.chatmode.md` file.**
116+
**Note: For more details, refer to the chosen custom chat mode's `.chatmode.md` file.**
128117

129118
# 🤝 Contributing
130119

chat-modes/code-commit-assistant.chatmode.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -65,15 +65,6 @@ To use this chat mode effectively, follow these steps:
6565
- Know what branch name you want to use for your changes
6666
- Ensure the directory having code changes is added as the context
6767

68-
### Setup
69-
70-
1. **Install the Chat Mode**: Copy the `code-commit-assistant.chatmode.md` file from the `/chat-modes` directory to your workspace's `.github/chatmodes` directory
71-
2. **Restart VS Code**: Restart VS Code to load the new chat mode
72-
3. **Start a New Chat Session**: Open the GitHub Copilot Chat panel in VS Code
73-
4. **Select the Chat Mode**: Click the dropdown menu at the bottom of the chat panel and select `code-commit-assistant.chatmode.md`
74-
5. **Choose the Model**: Select the model to be used. For example, `Claude Sonnet 4` (recommended for best performance)
75-
6. **Add Context**: Choose the appropriate directory having code changes as context for your specific task
76-
7768
### Prompt Examples
7869

7970
**Option 1: Let the mode prompt you with all the questions**

chat-modes/conversation-to-chat-mode.chatmode.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -83,15 +83,6 @@ To use this chat mode effectively, follow these steps:
8383

8484
- Ensure the directory having code changes is added as the context
8585

86-
### Setup
87-
88-
1. **Install the Chat Mode**: Copy the `conversation-to-chat-mode.chatmode.md` file from the `/chat-modes` directory to your workspace's `.github/chatmodes` directory
89-
2. **Restart VS Code**: Restart VS Code to load the new chat mode
90-
3. **Start a New Chat Session**: Open the GitHub Copilot Chat panel in VS Code
91-
4. **Select the Chat Mode**: Click the dropdown menu at the bottom of the chat panel and select `conversation-to-chat-mode.chatmode.md`
92-
5. **Choose the Model**: Select the model to be used. For example, `Claude Sonnet 4` (recommended for best performance)
93-
6. **Add Context**: Choose the appropriate directory having code changes as context for your specific task
94-
9586
### Prompt Examples
9687

9788
**Option 1: Let the mode prompt you with all the questions**

chat-modes/dockerfile-developer.chatmode.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -32,15 +32,6 @@ To use this chat mode effectively, follow these steps:
3232
- Know your application type and technology stack
3333
- Have access to dependency files if they exist
3434

35-
### Setup
36-
37-
1. **Install the Chat Mode**: Copy the `dockerfile-developer.chatmode.md` file from the `/chat-modes` directory to your workspace's `.github/chatmodes` directory
38-
2. **Restart VS Code**: Restart VS Code to load the new chat mode
39-
3. **Start a New Chat Session**: Open the GitHub Copilot Chat panel in VS Code
40-
4. **Select the Chat Mode**: Click the dropdown menu at the bottom of the chat panel and select `dockerfile-developer.chatmode.md`
41-
5. **Choose the Model**: Select the model to be used. For example, `Claude Sonnet 4` (recommended for best performance)
42-
6. **Add Context**: Choose the appropriate directory having code changes as context for your specific task
43-
4435
### Prompt Examples
4536

4637
**Option 1: Let the mode prompt you with all the questions**

chat-modes/terraform-helm-release-upgrade-analyser.chatmode.md

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ You are in "Terraform Helm Release Upgrade Analyser" mode. Your task is to creat
1616

1717
- You will scan the code in the provided context to find the Helm release Terraform object to figure out the Helm chart and its repository URL.
1818
- Then you will ask for the current Helm chart version and desired Helm chart version. You will not check VERSION for that purpose. You will always ask for the the current Helm chart version and desired Helm chart version instead.
19-
- Then you will compare the changes in all the template files and default values file between the provided current Helm chart version and the provided desired Helm chart version of the Helm release. You will use its GitHub.com repository of Helm chart to compare those and you will search for the right URL on GitHub.com for that Helm chart and the respective tags for comparison. Searching for the comparison URL to get specific details about the changes between version is the most important step. It is like a URL ending with `.diff` to see all the code changes between two tags.
19+
- Then you will compare the changes in all the template files and default values file between the provided current Helm chart version and the provided desired Helm chart version of the Helm release. You will use its GitHub.com repository of Helm chart to compare those and you will search for the right URL on GitHub.com for that Helm chart and the respective tags for comparison. Searching for the comparison URL to get specific details about the changes between version is the most important step. It is like a URL ending with `.diff` to see all the code changes between two tags. If it is not present on GitHub.com, search on GitLab.com.
2020
- Then you will search for all the breaking changes, if any, between the two versions on the web.
2121
- Then you will scan the code in the provided context again and do an analysis to find out all the required changes to be made based on the findings. There can be multiple directories in the context.
2222
- Then you will create a detailed upgrade plan based on the analysis.
@@ -42,15 +42,6 @@ To use this chat mode effectively, follow these steps:
4242
- Ensure you have Terraform code that contains a Helm release resource
4343
- Know the current and desired Helm chart versions for your upgrade
4444

45-
### Setup
46-
47-
1. **Install the Chat Mode**: Copy the `terraform-helm-release-upgrade-analyser.chatmode.md` file from the `/chat-modes` directory to your workspace's `.github/chatmodes` directory
48-
2. **Restart VS Code**: Restart VS Code to load the new chat mode
49-
3. **Start a New Chat Session**: Open the GitHub Copilot Chat panel in VS Code
50-
4. **Select the Chat Mode**: Click the dropdown menu at the bottom of the chat panel and select `terraform-helm-release-upgrade-analyser.chatmode.md`
51-
5. **Choose the Model**: Select the model to be used. For example, `Claude Sonnet 4` (recommended for best performance)
52-
6. **Add Context**: Choose the appropriate directory having code changes as context for your specific task
53-
5445
### Prompt Examples
5546

5647
**Option 1: Let the mode prompt you with all the questions**

0 commit comments

Comments
 (0)