Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
135 lines (101 loc) · 3.64 KB

CONTRIBUTING.md

File metadata and controls

135 lines (101 loc) · 3.64 KB

Contributing to OpenReview

Thank you for your interest in contributing to OpenReview! This document covers the process for contributing to this project.

Getting Started

  1. Fork the repository on GitHub
  2. Clone your fork locally: 
    git clone git@github.com:<your-username>/OpenReview.git
cd OpenReview
  3. Install dependencies: 
    nvm use        # Node 22 via .nvmrc
pnpm install
  4. Create a branch for your work: 
    git checkout -b feat/your-feature-name

Development Workflow

Build

pnpm build                          # all workspaces
pnpm --filter @openreview/core build # single workspace

Test

pnpm test                                        # all tests
npx vitest run core/src/config/env.test.ts       # single file
pnpm test:watch                                  # watch mode

Manual E2E Testing

# Review a real PR (fast mode)
GITHUB_TOKEN=ghp_xxx node cli/dist/main.mjs review --url <PR-URL> --output text

# Review + post findings to GitHub
GITHUB_TOKEN=ghp_xxx node cli/dist/main.mjs review --url <PR-URL> --submit

# Run the 10-PR QA suite
node tests/qa/test-10-prs.mjs

Lint & Format

pnpm lint          # check
pnpm lint:fix      # auto-fix
pnpm format        # format all files
pnpm format:check  # check formatting

All code must pass pnpm lint, pnpm typecheck, and pnpm test before submitting a PR.

Project Structure

core/    # @openreview/core — review engine, LLM router, GitHub client
cli/     # openreview — CLI (npx openreview)
action/  # @openreview/action — GitHub Action
web/     # Phase 2 placeholder (React 19 + Vite 8)
  • core/ contains all business logic. cli/ and action/ are thin wrappers.
  • All packages use ESM ("type": "module").
  • ESLint 10 flat config (eslint.config.js) — no .eslintrc files.
  • Vitest for testing — no Jest.
  • tsdown for bundling — no tsup.

Submitting a Pull Request

  1. Ensure your branch is up to date with main: 
    git fetch origin
git rebase origin/main
  2. Run all checks: 
    pnpm lint && pnpm typecheck && pnpm test
  3. Push your branch and open a PR against main.
  4. Fill in the PR template with a description of your changes.
  5. Wait for CI to pass and a maintainer to review.

Branch Naming

Prefix Use
feat/ New features
fix/ Bug fixes
refactor/ Code refactoring
docs/ Documentation only
test/ Test additions or fixes
chore/ Build, CI, dependency updates

Commit Messages

Use conventional commits:

feat: add copy/move detection to diff parser
fix: handle rate limit 403 in GitHub client
docs: update CLI examples in README

Reporting Issues

Open an issue on GitHub with:

  • Steps to reproduce
  • Expected vs actual behavior
  • Node.js version, OS, and relevant environment details

Project Guidance Files

  • CLAUDE.md — Architecture overview, commands, conventions for AI coding agents
  • REVIEW.md — OpenReview's own review rules (code style, architecture, testing, security)
  • SETUP.md — Detailed setup guide with configuration reference and troubleshooting

Code of Conduct

This project follows the Contributor Covenant Code of Conduct. By participating, you are expected to uphold this code.

License

By contributing, you agree that your contributions will be licensed under the MIT License.