A community-driven resource for amateur radio enthusiasts

Pull Requests

All changes to the site go through pull requests. This ensures quality and keeps the main branch deployable.

First time? Complete Local Setup before submitting a PR. You'll need to run the test suite locally to ensure your changes pass all checks.

Creating a Pull Request

1. Create a Branch

Branch from main with a descriptive name:

git checkout main
git pull
git checkout -b add-march-meeting

Naming conventions:

  • add-* — Adding new content
  • fix-* — Bug fixes
  • update-* — Updating existing content

2. Make Your Changes

Edit files, preview with npm run dev, then commit:

git add .
git commit -m "Add March 2026 meeting event"

Write clear commit messages that explain what changed.

3. Run Tests Locally

Before pushing, verify your changes pass all checks:

npm run build      # Ensure site builds
npm run test       # Run unit tests
npm run lint       # Check for code issues

Automated checks will run these same commands on your PR. Running them locally first saves time and catches issues early.

4. Push and Open PR

git push -u origin add-march-meeting

GitHub will show a link to create a pull request. Click it, add a description, and submit.

PR Description Template

## What

Brief description of changes.

## Why

Why is this change needed?

## Testing

- [ ] Previewed locally with `npm run dev`
- [ ] No TypeScript errors
- [ ] Content renders correctly

Automated Checks

Pull requests run these checks automatically:

Check What it does
Build Verifies the site builds without errors
TypeScript Type-checks all code
ESLint Checks for code quality issues
Tests Runs unit and E2E tests

All checks must pass before merging. Fix any failures by pushing additional commits to your branch.

Review Process

  1. A maintainer will review your PR
  2. They may request changes or ask questions
  3. Address feedback with additional commits
  4. Once approved, a maintainer will merge

Tip: Keep PRs focused. One event, one article, or one bug fix per PR. Large PRs are harder to review.

After Merging

After your PR merges, the site automatically rebuilds and deploys. Changes are live within minutes.

Clean up your local branch:

git checkout main
git pull
git branch -d add-march-meeting

Quick Edits via GitHub

For simple text fixes, you can edit directly on GitHub:

  1. Navigate to the file on GitHub
  2. Click the pencil icon (Edit)
  3. Make changes
  4. Choose "Create a new branch and start a pull request"

This works well for typos and small content updates. For anything more complex, use the local workflow.