Skip to content

Commit 0d08b93

Browse files
committed
Add tips for using Copilot to generate feature requirements in multiple languages
1 parent 57049bb commit 0d08b93

File tree

8 files changed

+49
-7
lines changed

8 files changed

+49
-7
lines changed

goals/dotnet/2-requirements.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,9 @@ Use this section to document key decisions made during feature design:
192192
- [ ] Performance benchmarks
193193
```
194194

195+
> [!TIP]
196+
> Try using Copilot to have it write your requirements for you! Copy the template, and surround it with <|TEMPLATE_START|><|TEMPLATE_END|>, and describe to the AI the Feature you'd like to plan! Then review and edit the generated markdown file to ensure that it matches what you want!
197+
195198
## ✅ Success Criteria
196199

197200
Your feature requirements document should demonstrate:

goals/dotnet/projectBrief.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,4 @@ To run the eShop project:
3737
3. Run the solution using Visual Studio or configure your environment using the provided PowerShell scripts.
3838

3939
## Internal Use and Demonstrations
40-
The eShop app has been featured in internal presentations such as the `[dotnet conf 2024 Keynote - Copy 3](https://microsoft.sharepoint.com/teams/DevRelTeam/_layouts/15/Doc.aspx?sourcedoc=%7B15D653EE-CFB6-4C32-8669-EF8B2367FE95%7D&file=dotnet%20conf%202024%20Keynote%20-%20Copy%203.pptx&action=edit&mobileredirect=true&DefaultItemOpen=1&EntityRepresentationId=421e3d07-d5fd-4cc9-b4ee-9dac667e0f4b)`, where it was used to demonstrate .NET 9
40+
The eShop app has been featured in internal presentations such as the [dotnet conf 2024 Keynote - Copy 3](https://microsoft.sharepoint.com/teams/DevRelTeam/_layouts/15/Doc.aspx?sourcedoc=%7B15D653EE-CFB6-4C32-8669-EF8B2367FE95%7D&file=dotnet%20conf%202024%20Keynote%20-%20Copy%203.pptx&action=edit&mobileredirect=true&DefaultItemOpen=1&EntityRepresentationId=421e3d07-d5fd-4cc9-b4ee-9dac667e0f4b), where it was used to demonstrate .NET 9

goals/java/1-setup.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,25 @@ Together, they transform GitHub Copilot into an intelligent development assistan
1717
## 🛠️ Installation & Setup
1818

1919
### Step 1: Clone and Copy Framework Files
20-
20+
#### Windows Terminal:
2121
```powershell
2222
# Clone this repository
2323
git clone https://github.com/ChrisMcKee1/AI-Assisted-Coding.git
2424
cd AI-Assisted-Coding
2525
2626
# Copy all framework files to your project's root directory
2727
# Replace 'your-project-path' with the actual path to your project
28-
Copy-Item -Path ".\*" -Destination "C:\path\to\your-project\" -Recurse -Force
28+
robocopy . "C:\path\to\your-project" /E /XD .git
29+
```
30+
31+
#### Linux / OSX Terminal:
32+
```bash
33+
git clone https://github.com/ChrisMcKee1/AI-Assisted-Coding.git
34+
cd AI-Assisted-Coding
35+
36+
# Copy all framework files to your project's root directory
37+
# Replace '/path/to/your-project' with the actual path to your project
38+
rsync -av --exclude='.git' . /path/to/your-project/
2939
```
3040

3141
### Step 2 (optional): Change the MCP Configuration

goals/java/2-requirements.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,9 @@ Use this section to document key decisions made during feature design:
192192
- [ ] Performance benchmarks
193193
```
194194

195+
> [!TIP]
196+
> Try using Copilot to have it write your requirements for you! Copy the template, and surround it with <|TEMPLATE_START|><|TEMPLATE_END|>, and describe to the AI the Feature you'd like to plan! Then review and edit the generated markdown file to ensure that it matches what you want!
197+
195198
## ✅ Success Criteria
196199

197200
Your feature requirements document should demonstrate:

goals/python/1-setup.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,25 @@ Together, they transform GitHub Copilot into an intelligent development assistan
1717
## 🛠️ Installation & Setup
1818

1919
### Step 1: Clone and Copy Framework Files
20-
20+
#### Windows Terminal:
2121
```powershell
2222
# Clone this repository
2323
git clone https://github.com/ChrisMcKee1/AI-Assisted-Coding.git
2424
cd AI-Assisted-Coding
2525
2626
# Copy all framework files to your project's root directory
2727
# Replace 'your-project-path' with the actual path to your project
28-
Copy-Item -Path ".\*" -Destination "C:\path\to\your-project\" -Recurse -Force
28+
robocopy . "C:\path\to\your-project" /E /XD .git
29+
```
30+
31+
#### Linux / OSX Terminal:
32+
```bash
33+
git clone https://github.com/ChrisMcKee1/AI-Assisted-Coding.git
34+
cd AI-Assisted-Coding
35+
36+
# Copy all framework files to your project's root directory
37+
# Replace '/path/to/your-project' with the actual path to your project
38+
rsync -av --exclude='.git' . /path/to/your-project/
2939
```
3040

3141
### Step 2 (optional): Change the MCP Configuration

goals/python/2-requirements.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,9 @@ Use this section to document key decisions made during feature design:
187187
- [ ] Performance benchmarks
188188
```
189189

190+
> [!TIP]
191+
> Try using Copilot to have it write your requirements for you! Copy the template, and surround it with <|TEMPLATE_START|><|TEMPLATE_END|>, and describe to the AI the Feature you'd like to plan! Then review and edit the generated markdown file to ensure that it matches what you want!
192+
190193
## ✅ Success Criteria
191194

192195
Your feature requirements document should demonstrate:

goals/typescript/1-setup.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,25 @@ Together, they transform GitHub Copilot into an intelligent development assistan
1717
## 🛠️ Installation & Setup
1818

1919
### Step 1: Clone and Copy Framework Files
20-
20+
#### Windows Terminal:
2121
```powershell
2222
# Clone this repository
2323
git clone https://github.com/ChrisMcKee1/AI-Assisted-Coding.git
2424
cd AI-Assisted-Coding
2525
2626
# Copy all framework files to your project's root directory
2727
# Replace 'your-project-path' with the actual path to your project
28-
Copy-Item -Path ".\*" -Destination "C:\path\to\your-project\" -Recurse -Force
28+
robocopy . "C:\path\to\your-project" /E /XD .git
29+
```
30+
31+
#### Linux / OSX Terminal:
32+
```bash
33+
git clone https://github.com/ChrisMcKee1/AI-Assisted-Coding.git
34+
cd AI-Assisted-Coding
35+
36+
# Copy all framework files to your project's root directory
37+
# Replace '/path/to/your-project' with the actual path to your project
38+
rsync -av --exclude='.git' . /path/to/your-project/
2939
```
3040

3141
### Step 2 (optional): Change the MCP Configuration

goals/typescript/2-requirements.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -191,6 +191,9 @@ Use this section to document key decisions made during feature design:
191191
- [ ] Performance benchmarks
192192
```
193193

194+
> [!TIP]
195+
> Try using Copilot to have it write your requirements for you! Copy the template, and surround it with <|TEMPLATE_START|><|TEMPLATE_END|>, and describe to the AI the Feature you'd like to plan! Then review and edit the generated markdown file to ensure that it matches what you want!
196+
194197
## ✅ Success Criteria
195198

196199
Your feature requirements document should demonstrate:

0 commit comments

Comments
 (0)