Skip to content

Latest commit

 

History

History
141 lines (95 loc) · 5.46 KB

CONTRIBUTING.md

File metadata and controls

141 lines (95 loc) · 5.46 KB

Contributing to Checkmate

Thanks for your interest in contributing! Checkmate is an open-source, friendly project focused on learning and growth.

We truly appreciate all kinds of contributions — code, ideas, translations or documentation. Contributing helps you level up while making the project better for everyone.

Before you start, please take a moment to read the relevant section. It helps us review and accept contributions faster, and makes the whole process smoother for everyone. 💚

PS: We work closely with contributors on our Discord channel. You’ll find community members, core maintainers, and first-timers helping each other out.

Table of contents

How do I...

Get help or ask a question?

Ask anything in our Discord server — we’re friendly and happy to help. Our core contributors are active and ready to support you. You can also use GitHub Discussions section to ask your questions.

Report a bug?

  1. Search existing issues.
  2. If it’s not listed, open a new issue.
  3. Include as much detail as possible: what happened, what you expected, and steps to reproduce. Logs and screenshots help.

Suggest a new feature?

  1. Open a new issue with the feature request template.
  2. Share your use case and why it would help.
  3. You can discuss it in Discord before you code.

Set up Checkmate locally?

Frontend:

npm install
npm run dev

Backend: Clone and follow instructions in checkmate-backend.

By default, the frontend expects the backend on http://localhost:3001. Update configs if needed.

Start contributing code?

  1. Pick or open an issue (check good-first-issues first)
  2. Ask to be assigned. If there is alrady someone assigned and it's been more than 7 days, you can raise the flag and ask to be assigned as well.
  3. Create a branch from develop.
  4. Write your code.
  5. Run and test locally.
  6. Open a PR to develop.

Start with good first issues.

Improve the documentation?

Docs live in checkmate-documentation. You can fix typos, add guides, or explain features better.

Help with translations?

We use PoEditor for translations. You can:

Make sure all new UI strings in code use t('key').

Submit a pull request?

Follow the pull request checklist. Your PR should:

  • Be focused on one issue.
  • Be tested locally.
  • Use our linting and translation rules.
  • Include the related issue (e.g. Fixes #123).
  • Be opened against the develop branch.

Code guidelines

  • Use ESLint and Prettier (npm run lint).
  • Follow naming conventions: camelCase for variables, PascalCase for components, UPPER_CASE for constants.
  • No hard-coded strings — use t('your.key') for everything visible.
  • Use the shared theme and components. No magic numbers or hardcoded styles.
  • Follow structure and patterns already used in the codebase.

Pull request checklist

Before submitting your pull request, please confirm the following:

  • You have tested the app locally and confirmed your changes work.
  • You reviewed your code and removed debug logs or leftover code.
  • The GitHub issue is assigned to you.
  • You included the related issue number in the PR description (e.g. Fixes #123).
  • All user-facing text uses the translation function t('key'); no hardcoded strings.
  • You avoided hardcoded URLs, config values, or sensitive data.
  • You used the shared theme for any styling — no magic numbers or inline styles.
  • The pull request addresses only one issue or topic.
  • You added screenshots or a video for any UI-related changes.
  • Your code passes linting and has no TypeScript errors.

If one or more of these are missing, we may ask you to update your pull request before we can merge it.

Branching model

  • Code contributions should go to the develop branch.
  • master is used for stable releases.
  • Use descriptive branch names, like fix/login-error or feat/add-alerts.

Thank you

Thanks for making Checkmate better. We mean it. Whether it’s your first pull request or your 50th, we’re excited to build with you.

PS: feel free to introduce yourself on Discord and say hi.

-- Checkmate team