-
Notifications
You must be signed in to change notification settings - Fork 27
Closed
Description
Overview
We have 7 open PRs from @Nantero1 adding new semantic anchors. Before merging, each needs to be reviewed for quality, structure, and completeness.
Open PRs
| PR | Anchor | Category (to verify) |
|---|---|---|
| #137 | CQRS | Software Architecture? |
| #138 | BDD (Given-When-Then) | Testing & Quality? |
| #139 | YAGNI | Design Principles? |
| #140 | GoF Design Patterns | Design Principles? |
| #141 | Chain of Responsibility | Design Principles? |
| #142 | Test Double (Meszaros) | Testing & Quality? |
| #143 | Event-Driven Architecture | Software Architecture? |
Review checklist per PR
- Is it a good semantic anchor? Does it meet our criteria: precise, rich, consistent, attributable? Or is it too broad/generic (e.g. GoF as a whole vs. individual patterns)?
- Structure check: Does the .adoc follow our standard template (Core Concepts, When to Use, Key Proponent, categories, roles)?
- Content quality: Are the descriptions accurate and concise? No fluff?
- German translation: Currently missing for all 7 PRs. Needs
.de.adocfiles. - Category assignment: Are the categories correct?
- all-anchors.adoc: Is the entry correctly added?
- catalog.md: Is the skill catalog entry correct?
Open questions
-
Merge first, then fix? Or fix before merge?
- Pro merge-first: Less work for the contributor, we can batch-fix translations
- Pro fix-first: Cleaner history, no broken state on main
- Suggestion: Review content quality and anchor suitability first (reject/request changes if needed), then merge acceptable ones and batch-add translations ourselves.
-
Anchor suitability concerns:
- GoF Design Patterns (feat: Add GoF Design Patterns semantic anchor #140): Very broad. Is "GoF" a single anchor, or should individual patterns (Strategy, Observer, etc.) be separate anchors? Or is the concept of GoF patterns itself the anchor?
- Chain of Responsibility (feat: Add Chain of Responsibility semantic anchor #141): Single GoF pattern as anchor. If we accept GoF as a whole, do we also want individual patterns?
- YAGNI (feat: Add YAGNI semantic anchor #139): Strong candidate, well-known principle. But how does it relate to our existing DRY anchor?
-
Consistency with existing anchors: Do the new ones follow the same depth and style as our existing 48 anchors?
Suggested workflow
- Review each PR for anchor quality (comment on PR if changes needed)
- Merge approved PRs one by one
- Batch-create German translations for all merged anchors
- Verify website builds correctly after each merge
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels