Contributing

Thank you for your interest in contributing to DomChekr! This guide covers how to set up the project locally and submit changes.

Code of conduct

All contributors are expected to follow our Code of Conduct. Please be respectful and constructive in all interactions.

Getting started

Prerequisites

• Node.js ≥ 22 (see .nvmrc)
• npm ≥ 10

Local setup

1. Fork and clone the repository

   git clone https://github.com/<your-username>/domchekr.git
   cd domchekr

2. Install dependencies

   npm install

3. Copy the environment file

   cp .env.example .env

   Fill in any required values. At minimum you need a local DB connection.

4. Start the development server

   npm run dev

   The site is now running at http://localhost:4321.

Making changes

Branches

Create a new branch from main for every change:

git checkout -b feat/my-feature
# or
git checkout -b fix/my-bug

Branch naming conventions:

Prefix	Use for
feat/	New features
fix/	Bug fixes
docs/	Documentation only
chore/	Build, deps, tooling
refactor/	Code reorganization without behaviour change

Commit messages

We follow Conventional Commits:

feat: add bulk CSV import for watchlist
fix: correct WHOIS timeout handling for .io TLDs
docs: add webhook signature verification example

Running checks locally

npm run build     # Ensure the site builds without errors

Tipp

Run a build before opening a PR. CI will catch build errors, but catching them locally is faster.

Opening a pull request

1. Push your branch to your fork.
2. Open a PR against the main branch of the upstream repo.
3. Fill in the PR template: describe the change, link related issues, and list any testing steps.
4. A maintainer will review and may request changes.

Reporting bugs

Open an issue at github.com/domchekr/domchekr/issues with:

• Steps to reproduce
• Expected vs actual behaviour
• Browser / OS / Node version if relevant

Requesting features

Open a Discussion before opening a feature issue. This lets us align on scope before you invest time building something.