Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
54 lines (36 loc) · 1.2 KB

CONTRIBUTING.md

File metadata and controls

54 lines (36 loc) · 1.2 KB

Contributing to @pons/web

Thanks for your interest in contributing!

Prerequisites

Development Setup

git clone https://github.com/usepons/web.git
cd web
deno install

Running Locally

# Start Vite dev server with HMR
deno task dev

# Production build
deno task build

# Serve built assets
deno task serve

The gateway module must be running for the frontend to connect — it provides the REST API and WebSocket endpoint.

Code Style

  • React 19 with TypeScript
  • TailwindCSS v4 — utility-first, no separate CSS modules
  • Components in src/components/, hooks in src/hooks/, API helpers in src/lib/
  • Run deno fmt before committing
  • Run deno lint to catch issues

Submitting Changes

  1. Fork the repository
  2. Create a branch from main (feat/dark-mode, fix/ws-reconnect)
  3. Make focused, atomic commits
  4. Test locally — verify UI behavior with a running gateway
  5. Open a pull request against main

Reporting Issues

Open an issue at github.com/usepons/web/issues.

License

By contributing, you agree that your contributions will be licensed under the MIT License.