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
Copy file name to clipboardExpand all lines: .github/copilot-instructions.md
+24Lines changed: 24 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -192,3 +192,27 @@ After upgrading, use VS Code's **Problems panel** (or `get_errors` tool) to conf
192
192
-`body: null` may not be allowed (use `body: ""` instead)
193
193
- New required properties may be added
194
194
- Property types may become stricter
195
+
196
+
## Common Mistakes to Avoid
197
+
198
+
### PRESET Metadata
199
+
-**PRESET should be "No"** for most samples
200
+
- Only set `"PRESET": "Yes"` if the sample is **reusable for other purposes** (e.g., a generic configuration that developers can apply to their own APIs)
201
+
- Having a `devproxyrc.json` config file does NOT automatically make it a preset
202
+
203
+
### Startup Commands
204
+
-`.devproxy/devproxyrc.json` is a **default path** that Dev Proxy looks for automatically
205
+
- When config is in `.devproxy/devproxyrc.json`, the startup command should just be `devproxy` (no `--config-file` needed)
206
+
- Only use `--config-file` when the config file is in a non-default location or has a non-default name
207
+
208
+
### Updating Dates
209
+
- When updating sample dates, **always update both files**:
210
+
-`assets/sample.json`: Update `updateDateTime` field
211
+
-`README.md`: Update the version history table with the new date
212
+
- Dates must stay in sync between these two files
213
+
-**Pre-release updates** (sample not yet merged to main):
214
+
- Update both `creationDateTime` and `updateDateTime` in `sample.json`
215
+
- Update the v1.0 date in the README version history table
216
+
-**Post-release updates** (sample already in main):
217
+
- Only update `updateDateTime` in `sample.json`
218
+
- Add a new version entry (e.g., 1.1) to the README version history table
0 commit comments