Skip to content

Commit 84de0c9

Browse files
committed
docs: cross-reference identifier-naming contributor guide
Adds a "Naming conventions" section pointing at the ecosystem-wide canonical reference at https://github.com/meshery/schemas/blob/master/docs/identifier-naming-contributor-guide.md Sistent components that surface API data (tables, form fields, charts) must use the camelCase-on-the-wire identifiers defined by the Meshery / Layer5 ecosystem contract. The new pointer sits above "Contributing to Sistent" so it is visible to anyone adding or reviewing component props that map to a Meshery or Layer5 Cloud response shape. No inline rules are duplicated here — the guide is the single authoritative directory. Signed-off-by: Lee Calcote <leecalcote@gmail.com>
1 parent c995430 commit 84de0c9

1 file changed

Lines changed: 4 additions & 0 deletions

File tree

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
The Sistent Design System provides the open source building blocks to design and implement consistent, accessible, and delightful product experiences. Visit the <a href="https://layer5.io/projects/sistent">project website</a> for more information.
44

5+
## Naming conventions
6+
7+
Sistent components that surface API data (tables, form fields, charts) must use the camelCase-on-the-wire identifiers defined by the Meshery / Layer5 ecosystem contract. See the [identifier-naming contributor guide](https://github.com/meshery/schemas/blob/master/docs/identifier-naming-contributor-guide.md) in `meshery/schemas` — the reader-friendly 26-row naming directory with before/after and do/don't examples — before adding props, column keys, or query-arg types that map to a Meshery or Layer5 Cloud response shape.
8+
59
## Contributing to Sistent
610

711
### Prerequisites

0 commit comments

Comments
 (0)