Skip to content

Commit cadf79a

Browse files
Copilothotlong
andcommitted
Improve naming conventions description clarity
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent f89d609 commit cadf79a

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -168,9 +168,9 @@ We welcome contributions! Please read our **[Contributing Guide](./CONTRIBUTING.
168168

169169
### Key Standards
170170

171-
- **Naming Conventions**:
172-
- Configuration keys: `camelCase` (e.g., `maxLength`, `referenceFilters`)
173-
- Machine names: `snake_case` (e.g., `name: 'project_task'`, `object: 'account'`)
171+
- **Naming Conventions**: Follow consistent naming across the codebase
172+
- Configuration keys (TypeScript properties): `camelCase` (e.g., `maxLength`, `referenceFilters`)
173+
- Machine names (data values): `snake_case` (e.g., `name: 'project_task'`, `object: 'account'`)
174174
- **Zod-First Design**: All schemas must be defined using Zod with runtime validation
175175
- **TypeScript**: Use strict TypeScript with comprehensive JSDoc comments
176176

0 commit comments

Comments
 (0)