First-time contributors welcome

Help build the prep tool we all wish existed.

Open-source, MIT-licensed, public roadmap. Whether you're fixing a typo, adding a data source, or designing a new export — there's a way in.

Ways in.

Six shapes of contribution. Pick the one that matches what you'd rather spend an afternoon on.

  • Bugs

    Hit something weird? File an issue with a reproducible example. Bug fixes ship faster than features and get prioritized accordingly.

  • Features

    Got an idea? Float it in Discussions first — saves design churn. Then an issue, then a PR. Small, well-scoped wins.

  • Docs

    README, the contributing guide, ADRs, code comments, error messages. Writing matters as much as the code; if something tripped you up, it'll trip the next person too.

  • Lookup sources

    Adapters for new data sources — eBay sold listings, Cardmarket variants, regional indexes. The lookup pipeline is built around source interfaces; adding one is a self-contained PR.

  • Web & SPA

    FastAPI + React + Tailwind. The web client mirrors the CLI; UI work and accessibility polish are always welcome.

  • Tests

    Edge cases, parser fixtures, integration coverage. The test suite is the safety net everyone else relies on — every contribution here punches above its weight.

How it works.

Three steps from "I'd like to help" to a merged PR. The full reference lives in docs/contributing.md.

  1. 01

    Pick (or open) an issue

    Every change is traceable to an issue. Browse the curated good-first-issue list, or open one yourself and tag the area. Comment to claim it before you start.

  2. 02

    Branch and implement

    Branch name format: <issueNumber>-<short-description>. Match existing patterns. Run make fix before committing — pre-commit hooks handle the rest.

  3. 03

    Open the PR

    Sign off with -s. Mirror the issue's labels and milestone on the PR. The local gate (make check) and CI must be green; first-time contributors get a celebration on the contributors thread when their PR merges.

Recognition.

What you get for showing up.

First PR celebration

When your first PR merges, we post a welcome on the contributors thread. Small thing; matters anyway.

Citable

Writing a blog post, paper, or talk that uses mgz-pkmn? The repo ships a CITATION.cff so a one-click citation is always available.

What's happening right now.

Pulled at build time from GitHub — refreshes whenever the site redeploys.

Open starter issues

see all →

Recently merged

see all →

Contributors

see all →

Everyone who's landed a commit. Your face goes here when your first PR merges.

Get started.

Three doors — pick whichever you'd rather walk through first.