diff --git a/docs/LOCAL_DEVELOPMENT.md b/docs/LOCAL_DEVELOPMENT.md new file mode 100644 index 0000000..9bd9d4d --- /dev/null +++ b/docs/LOCAL_DEVELOPMENT.md @@ -0,0 +1,37 @@ +# Local Development Checklist + +This checklist helps contributors verify that their local development +environment is correctly set up before submitting changes. + +## Environment + +- Node.js version matches the project requirements. +- Package manager versions are up to date. +- Environment variables are configured as expected. + +## Dependencies + +- All dependencies are installed successfully. +- No peer dependency warnings remain unresolved. +- Lockfiles are not modified unintentionally. + +## Code Quality + +- Linting passes without errors. +- Formatting matches the project standards. +- No unused imports or dead code remain. + +## Testing + +- Unit tests pass locally. +- New changes include appropriate test coverage. +- No flaky or non-deterministic tests are introduced. + +## Review Readiness + +- Commits are small and focused. +- Commit messages are clear and descriptive. +- Changes are easy to review and reason about. + +Following this checklist reduces review cycles +and improves overall code quality.