mirror of
https://github.com/phantomptr/ps5upload.git
synced 2026-10-22 20:03:07 -05:00
phantomptrandClaude Opus 5.5
c14782944d
Upload, install, convert and manage PS5 game packages over the network. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
63 lines
2.1 KiB
Markdown
63 lines
2.1 KiB
Markdown
# Code Review Checklist
|
|
|
|
Use this checklist when reviewing pull requests or your own code changes.
|
|
|
|
## Code Quality
|
|
- [ ] Code follows project style guidelines
|
|
- [ ] No unnecessary comments (code is self-documenting where possible)
|
|
- [ ] No hardcoded values that should be in config
|
|
- [ ] Error handling is appropriate
|
|
- [ ] No memory leaks (C code)
|
|
- [ ] No security vulnerabilities
|
|
|
|
## Functionality
|
|
- [ ] Feature works as described
|
|
- [ ] Edge cases are handled
|
|
- [ ] No regression in existing features
|
|
- [ ] Performance is acceptable
|
|
|
|
## Documentation Updates ⚠️ CRITICAL
|
|
**Every code change requires documentation updates!**
|
|
|
|
### Check if these files need updates:
|
|
- [ ] **README.md** - Main docs (features, usage, examples)
|
|
- [ ] **TESTING.md** - If validation, CI, coverage, or hardware test flow changed
|
|
- [ ] **FAQ.md** - If user-facing behavior changed
|
|
- [ ] **bench/README.md** - If benchmark or perf-gate behavior changed
|
|
- [ ] **tests/README.md** - If hardware smoke behavior changed
|
|
- [ ] **Code comments** - Updated for clarity
|
|
|
|
### Verify Documentation Accuracy:
|
|
- [ ] All example commands are tested and work
|
|
- [ ] Screenshots/diagrams match current version
|
|
- [ ] Configuration examples are current
|
|
- [ ] File paths in docs are correct
|
|
- [ ] No broken links
|
|
|
|
## Testing
|
|
- [ ] `npm run validate` passes locally or CI equivalent passed
|
|
- [ ] `npm run coverage` was reviewed for logic-heavy changes
|
|
- [ ] Unit tests pass
|
|
- [ ] Integration/mock tests pass
|
|
- [ ] Cross-platform target checks pass in CI
|
|
- [ ] Tested on real PS5 hardware (or equivalent)
|
|
- [ ] Tested edge cases
|
|
- [ ] Performance tested with large files
|
|
|
|
## Git Hygiene
|
|
- [ ] Commit messages are clear and descriptive
|
|
- [ ] No merge conflicts
|
|
- [ ] Branch is up to date with main
|
|
- [ ] No unnecessary files committed
|
|
- [ ] .gitignore is properly configured
|
|
|
|
## Before Merging
|
|
- [ ] All checklist items above are complete
|
|
- [ ] Documentation is 100% in sync with code
|
|
- [ ] CI/CD passes (if configured)
|
|
- [ ] At least one other person reviewed (if team project)
|
|
|
|
---
|
|
|
|
**Remember: Stale documentation is worse than no documentation. Always update docs with code changes!**
|