Clarify guidance on CONTEXT.md updates: emphasize meaningful terms for domain experts and avoid coupling to implementation details.
This commit is contained in:
parent
8868f54212
commit
3e251ea792
1 changed files with 2 additions and 0 deletions
|
|
@ -68,6 +68,8 @@ When the user states how something works, check whether the code agrees. If you
|
|||
|
||||
When a term is resolved, update `CONTEXT.md` right there. Don't batch these up — capture them as they happen. Use the format in [CONTEXT-FORMAT.md](./CONTEXT-FORMAT.md).
|
||||
|
||||
Don't couple `CONTEXT.md` to implementation details. Only include terms that are meaningful to domain experts.
|
||||
|
||||
### Offer ADRs sparingly
|
||||
|
||||
Only offer to create an ADR when all three are true:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue