Skip to content

Commit b272cc5

Browse files
committed
Add guidelines for writing user-focused release notes
1 parent 1e9bcb8 commit b272cc5

1 file changed

Lines changed: 30 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -583,6 +583,35 @@ DataLab development uses a **multi-root workspace** (`.code-workspace` file) wit
583583
2. Use `.env` file to point to local development versions
584584
3. Test changes in both Sigima unit tests AND DataLab integration tests
585585

586+
## Release Notes Guidelines
587+
588+
**Location**: `doc/release_notes/release_1.00.md`
589+
590+
**Writing Style**: Focus on **user impact**, not implementation details.
591+
592+
**Good release note** (user-focused):
593+
- ✅ "Fixed syntax errors when using f-strings with nested quotes in macros"
594+
- ✅ "Fixed corrupted Unicode characters in macro console output on Windows"
595+
- ✅ "Fixed 'Lock LUT range' setting not persisting after closing Settings dialog"
596+
597+
**Bad release note** (implementation-focused):
598+
- ❌ "Removed `code.replace('"', "'")` that broke f-strings"
599+
- ❌ "Changed QTextCodec.codecForLocale() to codecForName(b'UTF-8')"
600+
- ❌ "Added missing `ima_def_keep_lut_range` option in configuration"
601+
602+
**Structure**:
603+
- **What went wrong**: Describe the symptom users experienced
604+
- **When it occurred**: Specify the context/scenario
605+
- **What's fixed**: Explain the benefit, not the implementation
606+
607+
**Example**:
608+
```markdown
609+
**Macro execution:**
610+
611+
* Fixed syntax errors when using f-strings with nested quotes in macros (e.g., `f'text {func("arg")}'` now works correctly)
612+
* Fixed corrupted Unicode characters in macro console output on Windows - special characters like ✅, 💡, and → now display correctly instead of showing garbled text
613+
```
614+
586615
## Key Files Reference
587616

588617
| File | Purpose |
@@ -598,6 +627,7 @@ DataLab development uses a **multi-root workspace** (`.code-workspace` file) wit
598627
| `sigima/proc/image/processing.py` | Image computation functions |
599628
| `scripts/run_with_env.py` | Environment loader (loads `.env`) |
600629
| `.env` | Local PYTHONPATH for development |
630+
| `doc/release_notes/release_1.00.md` | Release notes for version 1.0.x |
601631

602632
## Getting Help
603633

0 commit comments

Comments
 (0)