-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdev_checklist.txt
More file actions
62 lines (47 loc) · 1.96 KB
/
dev_checklist.txt
File metadata and controls
62 lines (47 loc) · 1.96 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
# Development Checklist
## Constraints
- [ ] Do not delete failing tests. Explain first. Ask second. No delete.
- [ ] Do not turn off eslint warnings to avoid linting errors.
## Code Quality Guidelines
### Structure & Style
- [ ] Imports/Exports
- [ ] Imports at the top, exports at the bottom.
- [ ] Export named functions, types, objects.
- [ ] Import named functions, types, objects.
- [ ] Visibility: All primary functions should be exported.
- [ ] Immutability: Prefer `const` over `let` (`prefer-const`).
- [ ] Control Blocks:
- [ ] Always use braces `{}` for `if`, `for`, etc. (`curly`).
- [ ] Use only `for` loop. Do not use `while`, `do-while`.
- [ ] Use `switch` instead of if-else ladder for one variable.
- [ ] AI Agent Protocol: AI agents MUST honor the project's ESLint and EditorConfig settings for all modifications. Run `npm run lint` to verify compliance.
### Documentation & Examples
- [ ] JSDoc: Comprehensive JSDoc for all exported functions and types.
- [ ] Examples:
- At least 3 success examples showing different use cases.
- At least 1 error/fallback example showing edge cases.
### Consistency
- [ ] Default States: For complex types, provide a factory/function that returns default values.
- [ ] Cross-Lang Parity: Match default values with Golang zero-value conventions where applicable.
---
## Pre-flight Checklist
- [ ] Linting: Code passes npm run lint without warnings.
- [ ] Testing:
- [ ] Unit tests written for all new functionality.
- [ ] All tests pass: npm run test.
- [ ] Build: Project builds successfully: npm run build.
- [ ] Documentation:
- [ ] readme.txt updated with new features/changes.
- [ ] Generated docs refreshed: npm run docs && npm run docs:json.
- [ ] Version Control:
- [ ] changelog.txt updated for the current version.
- [ ] Identity verified (git log -n1) to protect PII.
---
## Useful Commands
```bash
# Full verification suite
npm run lint \
&& npm run build \
&& npm run test \
&& npm run docs
```