Template
first commit
This commit is contained in:
@@ -0,0 +1,25 @@
|
||||
---
|
||||
name: likec4
|
||||
description: Use when reading, creating, reviewing, or modifying LikeC4 *.c4 files. Enforces LikeC4 nomenclature, syntax, modeling conventions, and recommended practices.
|
||||
---
|
||||
|
||||
# LikeC4 modeling
|
||||
|
||||
Before changing any `*.c4` file:
|
||||
|
||||
1. Read `references/llms.txt` to locate the relevant documentation.
|
||||
2. Consult the applicable sections of `references/llms-full.txt`.
|
||||
3. Inspect the existing project models and follow `docs/modeling-conventions.md`.
|
||||
4. Use documented LikeC4 syntax rather than guessing.
|
||||
5. Follow LikeC4-recommended modeling practices.
|
||||
6. After editing, run `npm run validate` and resolve any errors caused by the change.
|
||||
|
||||
Pay particular attention to:
|
||||
|
||||
- element and relationship syntax
|
||||
- specification and model boundaries
|
||||
- views and predicates
|
||||
- deployment models
|
||||
- identifiers, titles, and naming conventions
|
||||
- supported styling and metadata
|
||||
- deprecated or discouraged syntax
|
||||
Reference in New Issue
Block a user