Contributing to Nova‑Z
Workflow
- Create a branch from
dev:git checkout -b feature/my-change - Make changes + tests; run lint/tests locally
- Submit PR to
devwith a clear summary and checklist - Address review feedback; keep PR scoped
- Merge via squash or rebase after approval(s) and green CI
- Periodically, open PR from
dev→mainfor release
PR Checklist
- Follows best practices and coding guidelines
- Adds/updates tests
- Updates docs (README/RUNNING/best practices) if needed
- No secrets or sensitive data committed
- Passing CI
Commit Conventions
Use Conventional Commits, e.g., feat: add SSE streaming client or fix(api): correct status code.
Issues & Discussions
- Use GitHub Issues for bugs/feature requests
- Link PRs to Issues
- Use GitHub Discussions for design proposals when appropriate