Contributing

Thanks for improving openings.dev.

Scope

This repository contains the static Next.js front-end. It does not store or generate opportunity data.

Use this repository for:

• UI and UX improvements.
• Routing, static page, and accessibility fixes.
• Remote data service improvements under lib/opportunities.
• Documentation updates for the front-end.

Use openings-dev/data-pipeline for:

• Source repository catalog changes.
• GitHub ingestion and normalization logic.
• Snapshot generation and static API files.

Data Rules

• Do not add local job data, mock datasets, fixtures, db.json, or JSON snapshots to the front-end.
• Do not import local .json files for opportunity data.
• Do not reintroduce a local /api/opportunities route.
• Keep raw data URL construction in lib/opportunities/static-api.ts.
• Keep static API reads in lib/opportunities/api.ts.
• Keep snapshot reads in lib/opportunities/snapshot.ts.

Development Setup

Requirements:

• Node.js >=20.9.0
• npm

npm install
npm run dev

Open http://localhost:3000.

Only create .env.local when testing another remote data branch:

NEXT_PUBLIC_OPENINGS_DATA_BASE_URL=https://raw.githubusercontent.com/openings-dev/data-pipeline/main/snapshots/opportunities
NEXT_PUBLIC_OPENINGS_DATA_REPOSITORY_BASE_URL=https://raw.githubusercontent.com/openings-dev/data-pipeline/main

Project Structure

app/                      App Router routes and route-local UI
components/               shared shell, providers, icons, and UI primitives
lib/opportunities/        remote data services, routing helpers, and domain types
lib/translations/         localized UI messages
lib/utils/                shared utilities
docs/                     localized markdown rendered by the app

Pull Request Workflow

1. Create a branch from main.
2. Keep the change focused.
3. Run checks:

npm run lint
npm run build

1. Open a pull request with:

• Clear summary.
• Screenshots for visual changes.
• Test notes listing the commands you ran.
• Any data source override used during testing.

Pull Request Checklist

• No local data files or JSON imports were added.
• Remote data access remains centralized in lib/opportunities.
• Components stay focused and reusable.
• Documentation changed when behavior or setup changed.
• npm run lint and npm run build pass locally.

Code of Conduct

By participating, you agree to follow the Code of Conduct.