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
docs(copilot): add Conventional Commits standards and scope guidance
- Document Conventional Commits 1.0.0 specification from Context7
- Add required types (feat, fix) and recommended types
- Define scopes as functional/logical areas, not physical projects
- Include common scopes: core, ui, logging, config, build, ci, tests, etc.
- Provide examples and guidance on when to use/omit scopes
- Document breaking change notation and footer conventions
- Cross-reference with Serena memory for consistency
-`validation` - Validation system (rules, engine, strictness modes)
303
+
-`processing` - File processing pipeline and batch operations
304
+
-`tracks` - Track configuration and track-level logic
305
+
-`mkvtools` - mkvpropedit/MediaInfo integration
306
+
307
+
*Infrastructure:*
308
+
-`config` - Configuration and settings
309
+
-`logging` - Logging system
310
+
-`di` - Dependency injection and service registration
311
+
-`nav` - Navigation system
312
+
313
+
*Tooling:*
314
+
-`deps` - Package dependencies
315
+
-`dev` - Development tooling
316
+
317
+
*Documentation:*
318
+
-`instructions` - AI assistant instructions (copilot-instructions.md, Serena memories)
319
+
320
+
*Release:*
321
+
-`version` - Version management
322
+
-`release` - Release and publishing
323
+
324
+
> **Note:**`build`, `ci`, `docs`, and `test` are commit **types**, not scopes. Use them as types (e.g., `build: update project files`, `test: add validation tests`).
325
+
326
+
**When to use a scope:**
327
+
- Changes focus on a specific functional area or component
-`Closes: #123` or `Fixes: #123` or `Resolves: #123` - Close issues
356
+
-`Reviewed-by:`, `Acked-by:`, `See-also:` - Other standard git trailers
357
+
358
+
### Examples
359
+
360
+
**Simple feature:**
361
+
```
362
+
feat(core): add subtitle track reordering support
363
+
```
364
+
365
+
**Bug fix with body and footer:**
366
+
```
367
+
fix(ui): prevent UI freeze during large batch operations
368
+
369
+
- Move batch processing to background thread
370
+
- Add progress reporting with cancellation support
371
+
- Update MainViewModel to marshal UI updates
372
+
373
+
Closes: #89
374
+
```
375
+
376
+
**Breaking change with scope:**
377
+
```
378
+
feat(core)!: redesign track configuration API
379
+
380
+
- Replace TrackConfiguration with immutable TrackInfo
381
+
- Update all track ViewModels to use new API
382
+
- Migration guide added to docs/migration.md
383
+
384
+
BREAKING CHANGE: TrackConfiguration class removed, use TrackInfo instead
385
+
Refs: #125
386
+
```
387
+
388
+
**Documentation update:**
389
+
```
390
+
docs: update README with mkvpropedit installation guide
391
+
392
+
Refs: #42
393
+
```
394
+
395
+
### Important Rules
396
+
- Type and description are REQUIRED
397
+
- Description MUST immediately follow the colon and space
398
+
- Scope MUST be a noun in parentheses if provided
399
+
- BREAKING CHANGE footer MUST be uppercase
400
+
- Breaking changes can use `!` in prefix OR footer (or both)
401
+
- Tokens other than BREAKING CHANGE are case-insensitive
402
+
403
+
> **Cross-reference**: Detailed Conventional Commits standards are also in Serena's memory (`.serena/memories/task_completion_checklist.md`). Keep both locations synchronized.
404
+
262
405
## **CRITICAL: Always Use Serena First (#serena MCP server)**
263
406
264
407
**Serena is a semantic code analysis toolkit that provides IDE-like capabilities to AI assistants. It's designed for:**
@@ -361,7 +504,7 @@ dotnet test --filter "FullyQualifiedName~BatchConfigurationTests"
361
504
2. Update relevant sections in this file
362
505
3. Update Serena memories to match
363
506
4. Update "Last Updated" date at the top
364
-
5. Commit both code changes and instruction updates together
507
+
5. Commit both code changes and instruction updates together using Conventional Commits format
0 commit comments