Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (52 loc) · 2.22 KB

CONTRIBUTING.md

File metadata and controls

70 lines (52 loc) · 2.22 KB
Raw

Contributing

Thanks for taking the time to improve OnTrack.

Project Scope

OnTrack is a Taiwan railway schedule app with three main surfaces:

  • apps/ios: native iOS app
  • apps/web: web app and public documentation site
  • apps/worker: Cloudflare Worker API and cache layer

The official app is published by Hsi. Forks and redistributions should use their own app name, icons, screenshots, bundle identifier, support links, privacy policy, backend, and App Store listing.

Development

Use Bun for JavaScript and TypeScript work:

bun install
bun run dev
bun run build
bun run lint

For iOS development, the project scripts wrap common Xcode workflows:

bun run ios
bun run ios:simulator
bun run ios:check

Worker Setup

The tracked Worker config uses placeholder deployment values and is intended for local development or fork setup. Before deploying a fork:

  1. Create your own Cloudflare D1 database.
  2. Copy apps/worker/wrangler.production.example.jsonc to apps/worker/wrangler.production.jsonc.
  3. Fill in the Cloudflare account_id, production route, and D1 database_id.
  4. Set CORS_ALLOWED_ORIGINS in the production config to your web origin.
  5. Set Worker secrets for production:
wrangler secret put TDX_CLIENT_ID --config apps/worker/wrangler.production.jsonc
wrangler secret put TDX_CLIENT_SECRET --config apps/worker/wrangler.production.jsonc
wrangler secret put REFRESH_SECRET --config apps/worker/wrangler.production.jsonc

TDX_CLIENT_ID and TDX_CLIENT_SECRET are optional for development. Without them, the Worker uses TDX Visitor Mode.

Use bun run deploy:dev:dry-run before bun run deploy:dev for the tracked development config after filling its D1 placeholder. Run bun run deploy:prod:check and bun run deploy:prod:dry-run before using bun run deploy with the ignored production config. Deployment refuses unresolved template placeholders.

Pull Requests

  • Keep changes focused.
  • Include tests or manual verification notes for behavior changes.
  • Use existing code style and project conventions.
  • Do not commit credentials, private .env files, provisioning profiles, archives, or production deployment identifiers.
  • Do not reuse OnTrack brand assets for redistributed forks.