Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (46 loc) · 1.91 KB

CONTRIBUTING.md

File metadata and controls

67 lines (46 loc) · 1.91 KB

Contributing to Reqcore

Thanks for contributing to Reqcore.

Before You Start

Development Setup

git clone https://github.com/reqcore-inc/reqcore.git
cd reqcore
cp .env.example .env
docker compose up -d
npm install
npm run dev

Branch and Commit Workflow

  1. Create a topic branch from main.
  2. Keep commits focused and atomic.
  3. Ensure every commit includes a DCO sign-off.
  4. Open a pull request with a clear summary and testing notes.

DCO Sign-off (Required)

Reqcore uses the Developer Certificate of Origin (DCO) instead of a CLA.

Sign every commit with:

git commit -s -m "feat: add candidate search"

This adds a Signed-off-by: line to your commit message. Pull requests fail CI if commits are missing sign-off.

Pull Request Checklist

  • I scoped changes to one concern.
  • I tested the change locally.
  • I updated docs when behavior or policy changed.
  • I did not introduce tenant-scope or auth regressions.
  • All commits are DCO signed (git commit -s).

Coding and Product Conventions

  • Follow Nuxt 4 app/ + root server/ structure.
  • Use Tailwind CSS v4 utilities and lucide-vue-next icons.
  • Use env from server/utils/env.ts (never process.env directly in server code).
  • For domain data, always scope server queries by organizationId from session.

Documentation

If your changes affect behavior, architecture, or roadmap status, update:

Code of Conduct

By participating, you agree to follow CODE_OF_CONDUCT.md.