Skip to main content

Open Core Contribution Workflow

This workflow is for contributors working in the public OpenArca repository.

1. Pick scope​

  • Start from issue/roadmap item with clear acceptance criteria.
  • Keep one PR focused on one problem.
  • Prefer small, reviewable increments.

2. Create branch​

Recommended branch naming:

  • feat/<short-topic>
  • fix/<short-topic>
  • chore/<short-topic>

3. Implement with security guardrails​

Do not regress:

  • RBAC checks,
  • ownership restrictions,
  • validation on write paths,
  • upload limits,
  • rate limits.

4. Run quality gates locally​

Backend:

cd backend
npm run lint
npm test

Frontend:

cd frontend
npm run lint
npm test
npm run build

Smoke stack:

docker compose up --build -d
docker compose ps
curl -s http://localhost:4000/health

5. Validate key user flows​

At minimum:

  • OTP login,
  • create ticket,
  • open ticket detail,
  • board status update,
  • DevTodo synchronization,
  • closure summary before close.

6. Commit style​

Use conventional commits:

  • feat(scope): ...
  • fix(scope): ...
  • chore(scope): ...

7. Pull request checklist​

  • scope is clear and limited,
  • tests are passing,
  • migration/ops impact is documented,
  • docs are updated when behavior changes.