Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (21 loc) · 963 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (21 loc) · 963 Bytes
Raw

Contributing

Rejecthon is intentionally small. Prefer changes that remove code, narrow the public surface, or make the submit() plus leaderboard() workflow easier to understand.

Setup

git clone https://github.com/vathymut/rejecthon.git
cd rejecthon
uv sync

Common checks

uv run pytest tests/ -v
uv run ruff check src tests
uv run ruff format .
uv run mkdocs build

Change rules

  • Keep the public API centered on rejecthon.submit and rejecthon.leaderboard.
  • Prefer focused deletions and simplifications over new wrappers or alternate workflows.
  • Update tests and docs when behavior or terminology changes.
  • Do not hand-edit generated outputs under site/ or ignored artifact trees such as models/, reports/, and data/processed/ unless the task explicitly targets generated files.
  • Follow the repo-specific instructions under .github/copilot-instructions.md and .github/instructions/ when they apply.