docs: cross-reference the identifier-naming contributor guide#1439
docs: cross-reference the identifier-naming contributor guide#1439leecalcote merged 1 commit intomasterfrom
Conversation
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>
There was a problem hiding this comment.
Code Review
This pull request adds a new 'Naming conventions' section to the README.md, outlining the requirement for Sistent components to use camelCase identifiers for API data. Feedback was provided to remove a specific row count reference in the documentation to prevent it from becoming outdated as the linked guide grows.
|
|
||
| ## Naming conventions | ||
|
|
||
| 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. |
There was a problem hiding this comment.
The specific mention of "26-row" is a maintenance risk as the naming guide is likely to grow or change over time. Removing this specific count makes the documentation more durable.
| 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. | |
| 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 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. |
There was a problem hiding this comment.
Pull request overview
This PR updates Sistent’s top-level documentation to cross-reference the ecosystem’s canonical identifier naming guidance, helping contributors align component props/keys with Meshery / Layer5 API field naming.
Changes:
- Adds a new “Naming conventions” section to
README.md. - Links to the
meshery/schemasidentifier-naming contributor guide as the authoritative reference.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ## Naming conventions | ||
|
|
||
| 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. |
There was a problem hiding this comment.
This sentence hard-codes a potentially fast-stale detail ("26-row") and links to a moving branch ref (blob/master). Consider removing the row count/extra descriptive claims and linking via a permalink (commit SHA) or another stable reference to avoid the README drifting over time.
| 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. | |
| 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 `meshery/schemas/docs/identifier-naming-contributor-guide.md` before adding props, column keys, or query-arg types that map to a Meshery or Layer5 Cloud response shape. |
leecalcote
left a comment
There was a problem hiding this comment.
Cross-reference pointer to the meshery/schemas identifier-naming contributor guide. README-only add.
Summary
Adds a "Naming conventions" section to
README.mdpointing 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.
Paired cross-reference PRs are being opened in
meshery/schemas,meshery/meshery,layer5io/meshery-cloud,layer5labs/meshery-extensions, andmeshery/meshkit.Test plan
git diff --statshows 1 doc-only file, +4 lines / -0 lines, no code modified.origin/master, signed off per DCO.