Skip to content

Commit bec3bc9

Browse files
committed
ci: update CodeRabbit config since SCHEMAS.md was introduced
1 parent 85a07c4 commit bec3bc9

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

.coderabbit.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,9 @@ reviews:
88
99
Pass/fail criteria:
1010
1. If any file in lexicons/**/*.json is added, modified, or deleted:
11-
- README.md must be updated to reflect the lexicon changes (new lexicons documented, modified properties updated, removed lexicons removed from docs)
11+
- If README.md already references that lexicon, it must be updated to reflect the lexicon changes (modified properties updated, removed lexicons removed from docs). If it doesn't already then it's *recommended* but *not mandatory* to add some docs to it for the lexicon in question. However the README.md shouldn't duplicate what's in SCHEMAS.md.
1212
- ERD.puml must be updated if entity relationships changed (new entities added, relationships modified, entities removed)
13+
- SCHEMAS.md must be updated with any relevant changes (e.g. fields or lexicons added/changed/removed)
1314
1415
2. If README.md is modified:
1516
- All documented lexicons must exist as JSON files in lexicons/

0 commit comments

Comments
 (0)