Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
57 lines (41 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

57 lines (41 loc) · 1.27 KB
Raw

Contributing to CodeBoard

Thanks for your interest in contributing.

Getting started

  1. Fork the repository.
  2. Create a feature branch from main.
  3. Install dependencies with lockfile:
    • npm ci
  4. Configure environment:
    • copy .env.example to .env (if applicable)
    • fill required variables
  5. Start locally:
    • start-codeboard.bat (Windows)
    • or npm run dev

Requirements

  • Node.js LTS (recommended: Node 22 LTS)
  • npm

Development rules

  • Keep changes focused and minimal.
  • Do not commit secrets, local databases, or private logs.
  • Follow existing code style and architecture.
  • Prefer small, reviewable pull requests.

Pull request checklist

  • The change is scoped to one clear goal.
  • No secrets or local artifacts are included.
  • Docs are updated when behavior changes.
  • PR description explains:
    • what changed
    • why it changed
    • how to test it

Commit message style

Use clear, concise messages. Example:

  • feat(ui): add follow-up block under approve
  • fix(rounds): correct review/final-draft phase labels
  • docs(readme): update setup instructions

Reporting bugs

Please open an issue with:

  • expected behavior
  • actual behavior
  • steps to reproduce
  • screenshots/logs if useful
  • environment (OS, Node, browser)