Skip to content

Commit 38b10ef

Browse files
Updates
1 parent 969a60c commit 38b10ef

File tree

4 files changed

+27
-3
lines changed

4 files changed

+27
-3
lines changed

.github/copilot-instructions.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,3 +192,27 @@ After upgrading, use VS Code's **Problems panel** (or `get_errors` tool) to conf
192192
- `body: null` may not be allowed (use `body: ""` instead)
193193
- New required properties may be added
194194
- 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

samples/api-key-protected-mock/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This sample demonstrates how to simulate API key authentication for mock APIs us
1818

1919
Version|Date|Comments
2020
-------|----|--------
21-
1.0|January 10, 2026|Initial release
21+
1.0|January 18, 2026|Initial release
2222

2323
## Minimal path to awesome
2424

samples/api-key-protected-mock/assets/sample.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99
"longDescription": [
1010
"Demonstrates how to simulate API key authentication for mock APIs using Dev Proxy with AuthPlugin and MockResponsePlugin."
1111
],
12-
"creationDateTime": "2026-01-10",
13-
"updateDateTime": "2026-01-10",
12+
"creationDateTime": "2026-01-18",
13+
"updateDateTime": "2026-01-18",
1414
"products": [
1515
"Dev Proxy"
1616
],
1.22 MB
Loading

0 commit comments

Comments
 (0)