-
Notifications
You must be signed in to change notification settings - Fork 107
Open
Labels
Milestone
Description
Why
- Resolve stack traces from field crashes.
How (Implementation sketch)
- Publish symbols to a server/Sentry; document process.
Definition of Done
- Code committed with minimal docs/tests.
- If client work: sample scene or prefab updated and runnable.
- Errors surface to logs/toasts; no silent failure.
- Meets privacy defaults (no content capture, aggregates only).
Acceptance Criteria
- Test crash resolves to readable stack with line numbers.
Notes
- Each new Unity C# script or module ≤ 200 LOC (except generated code); keep functions short & single-responsibility.
Implementation Guidelines
Code Quality Standards:
- Each new script/module ≤200 LOC (single responsibility principle)
- Use meaningful variable names (no single letters except loop counters)
- Add XML doc comments for public methods
- Follow project naming conventions (PascalCase for C#, camelCase for TS)
Testing Requirements:
- Unit tests for business logic
- Integration tests for API endpoints
- Manual testing checklist in PR
- Performance profiling if affecting critical path
Documentation:
- Update relevant README.md files
- Add inline code comments for complex logic
- Document any environment variables or config changes
- Update API documentation if adding/changing endpoints
Dependencies:
- Check Prerequisites section in main README
- Document any new package dependencies
- Verify compatibility with existing stack
- Update lock files (pnpm-lock.yaml, Packages/manifest.json)
Review Checklist:
- Code follows style guide
- Tests pass locally
- No console errors/warnings
- Performance acceptable (profile if unsure)
- Documentation updated
- PR description explains changes clearly
Common Patterns:
See /vr-office/docs/patterns/ for:
- Unity component patterns
- API service patterns
- React component patterns
- Error handling patterns