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`)
160
122
- **Co-location** - Tests (`.spec.tsx`) and stories (`.stories.tsx`) next to components
161
123
- **Index exports** - Each directory has an index.ts exporting public API
162
124
- **Flat structure** within features - avoid unnecessary nesting
163
125
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
+
164
130
### Documentation
165
131
166
132
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.
@@ -210,8 +176,7 @@ make prettier # Format code
210
176
feat: Add support for custom row actions in Datagrid
211
177
docs: Clarify dataProvider response format
212
178
```
213
-
214
-
4. **Documentation**: Update relevant docs for API changes
179
+
4. Use Pull Request Description Template
215
180
216
181
### Common Make Commands
217
182
```bash
@@ -241,6 +206,7 @@ make run-demo # Run demo application
241
206
- Test with screen readers
242
207
243
208
### Browser Support
209
+
244
210
- Modern browsers only (Chrome, Firefox, Safari, Edge)
245
211
- No IE11 support
246
212
- ES5 compilation target for compatibility
@@ -298,4 +264,4 @@ Kept minimal to critical user paths due to maintenance overhead.
0 commit comments