Skip to main content
Magic Resume is MIT-licensed and accepts contributions. PRs that come with reproductions, tests, and a clear why tend to land fast.

​
Before you start

  • Search existing issues and the PR list to avoid duplicate work.
  • For anything bigger than a small fix or doc tweak, open an issue first and describe the approach. This saves us both from a “thanks but no” on a finished PR.
  • New deployment modes, new auth flows, or new local/cloud switches require maintainer signoff before you write code — these are intentionally narrow.

​
Workflow

  1. Fork the repo and clone your fork.
  2. Create a branch off master: git checkout -b feat/<short-name>.
  3. pnpm install at the repo root.
  4. Make your change. Keep the diff scoped — one PR, one concern.
  5. Run the gates: pnpm run lint && pnpm run test. The Husky pre-commit hook runs a subset automatically, but the full sweep is cheaper than a red CI.
  6. Open a PR with a description of what and why. Link the issue if there is one.

​
Hard rules

Do not modify Clerk auth without a maintainer asking for it. That includes clerkMiddleware, <ClerkProvider>, useAuth, and the cloud sync layer in useResumeStore. The cloud/self-hosted split depends on these being predictable.
Do not add new local/cloud toggles or deployment modes. The current NEXT_PUBLIC_APP_MODE split is intentional. If you think you need a third mode, open an issue first.
@magic-resume/mcp must stay browser-free. No React, no Next.js, no window, no IndexedDB. If you import one of those by accident, node --test will catch you, but please catch yourself first.

​
Where things go

See Architecture for the why behind each of these.

​
Commit style

Conventional commits, present tense. Run git log --oneline to see the house style:

​
License

By submitting a PR you agree to license your contribution under the MIT License.