Contributing | Resume Matcher

Get Involved

Resume Matcher is open source. We build features, fix bugs, and improve docs together.

Quick Start

Fork the repo
Clone your fork, then follow Installation to start the backend in apps/backend and the frontend in apps/frontend
Create a branch: git checkout -b fix/your-thing
Make changes, commit, push, open a PR

What We Need

Code contributions:

Bug fixes
New features
Performance improvements
Tests

Non-code contributions:

Documentation improvements
UI translations
Bug reports with reproduction steps
Feature ideas
Helping others on Discord

Commit Style

Keep commits concise. Use sentence-style subjects:

Add keyword highlighting to JD match view
Fix PDF margin calculation on US Letter
Update Docker setup instructions

Before Submitting

Run npm run lint in apps/frontend, and uv run ruff check and uv run ruff format in apps/backend
To run the same checks (tests, ruff, locale parity) before every push, enable the hook once with git config core.hooksPath .githooks
Test your changes locally
Update docs if you changed behavior
Write a clear PR description

Using AI Coding Tools?

If you’re using Claude Code, Cursor, Windsurf, or similar AI tools, point them at docs/agent/README.md. It explains the repo structure, conventions, and patterns the AI should follow.

Good First Issues

New here? Look for issues labeled good first issue or help wanted on GitHub.

Get Help

All contributors are listed on resumematcher.fyi/about. Thanks for helping job seekers land interviews.