Skip to content

Commit 10087b2

Browse files
Apply suggestions from code review
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 701a903 commit 10087b2

3 files changed

Lines changed: 5 additions & 3 deletions

File tree

.github/instructions/documentation.instructions.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,9 @@ When creating samples for external documentation:
216216

217217
## Changelog Documentation
218218

219-
When adding features, update CHANGELOG.md:
219+
Do not edit `CHANGELOG.md` directly. The changelog is updated as part of the release workflow based on the contents of `release-notes/` and the `release-notes` prompt.
220+
221+
When adding features, fixes, or breaking changes, create or update the appropriate entry under `release-notes/` instead. For example:
220222
```markdown
221223
## [Unreleased]
222224

.github/prompts/update-build-pipelines.prompt.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Follow this workflow step-by-step:
5656
## 5. Validate
5757
- Verify YAML syntax is valid.
5858
- Ensure no hardcoded values that should be parameterized.
59-
- Check that variable references use the correct syntax (`$(variable)` for compile-time, `${{ parameters.param }}` for template parameters).
59+
- Check that variable and parameter references use the correct syntax (`$(variable)` for runtime/macro variables, `${{ parameters.param }}` for compile-time/template parameters).
6060
- Confirm template references use correct relative paths.
6161

6262
## 6. Checklist

AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ This repository provides reusable prompts in `.github/prompts/` for common maint
6969
3. Update reference assemblies if adding public APIs
7070
4. Implement with tests
7171
5. Add samples to `doc/samples/`
72-
6. Update CHANGELOG.md
72+
6. Do not edit `CHANGELOG.md` directly; instead, add a suggested release-note entry (per `.github/copilot-instructions.md`) in the PR description or via the release-notes workflow/prompt.
7373

7474
### Adding Connection String Keywords
7575
1. Add to `SqlConnectionStringBuilder`

0 commit comments

Comments
 (0)