You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- **Feature-based structure** within packages (not type-based)
121
-
- **One file per component** except for components that can't be used in standalone (e.g. `DataTable.Col`)
122
160
- **Co-location** - Tests (`.spec.tsx`) and stories (`.stories.tsx`) next to components
123
161
- **Index exports** - Each directory has an index.ts exporting public API
124
162
- **Flat structure** within features - avoid unnecessary nesting
125
163
126
-
### JSDoc
127
-
128
-
Every hook or component must have basic usage described in JSDoc, including a non-trivial example. No need to document all options - IDEs display TypeScript types for that.
129
-
130
164
### Documentation
131
165
132
166
Every new feature or API change must be documented. The documentation consists of Markdown files located in the `/docs/` directory and built with Jekyll, one file per component or hook.
@@ -176,7 +210,8 @@ make prettier # Format code
176
210
feat: Add support for custom row actions in Datagrid
177
211
docs: Clarify dataProvider response format
178
212
```
179
-
4. Use Pull Request Description Template
213
+
214
+
4. **Documentation**: Update relevant docs for API changes
180
215
181
216
### Common Make Commands
182
217
```bash
@@ -206,7 +241,6 @@ make run-demo # Run demo application
206
241
- Test with screen readers
207
242
208
243
### Browser Support
209
-
210
244
- Modern browsers only (Chrome, Firefox, Safari, Edge)
211
245
- No IE11 support
212
246
- ES5 compilation target for compatibility
@@ -264,4 +298,4 @@ Kept minimal to critical user paths due to maintenance overhead.
0 commit comments