adaptai / projects /nova-z /CONTRIBUTING.md
ADAPT-Chase's picture
Add files using upload-large-folder tool
fbf3c28 verified

Contributing to Nova‑Z

Workflow

  1. Create a branch from dev: git checkout -b feature/my-change
  2. Make changes + tests; run lint/tests locally
  3. Submit PR to dev with a clear summary and checklist
  4. Address review feedback; keep PR scoped
  5. Merge via squash or rebase after approval(s) and green CI
  6. Periodically, open PR from devmain for 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