33 lines (25 loc) · 878 Bytes

Contributing to Pocket Server

Thank you for your interest in contributing!

Getting started locally

npm install
npm run dev
# server at http://localhost:3000

Optional commands:

npm run build – bundle to dist/
npm start – run built server
npm run lint – Biome checks

Submitting changes

Fork the repo and create a feature branch.
Keep edits focused and small.
Include a short description of the change and why.
If your change affects behavior or APIs, note it in the PR description.
I will manually test PRs locally before merging.

Style

TypeScript, strict and descriptive naming.
Avoid introducing any in exported APIs.
Prefer early returns and clear error handling.

Reporting issues

Use the Bug/Feature templates; include steps to reproduce and logs if relevant.

Thanks for helping improve Pocket Server!