Contributing
Thank you for improving ThirdFlare One.
Setup
bash
git clone https://github.com/bodencrouch/thirdflare-one.git
cd thirdflare-one
npm install
npm run check
npm run test:allConventions
- 2-space indent,
camelCasein JS,kebab-casefilenames - Conventional Commits for release-please
- Product name ThirdFlare One in user-facing strings
- Plain language in UI — no planning/prompt copy
Test planes
| Plane | Scope |
|---|---|
| M | Mock warp-cli — required CI on Linux/macOS/Windows |
| R | Real WARP smoke — optional Ubuntu |
See CI.md.
Before handoff
bash
npm run check
npm run test:allAfter API changes, smoke /api/health, /api/version, /api/account, /api/killswitch, /api/update/check.
Docs
- Repository markdown:
docs/ - Published site: this VitePress site (
website/) - Update both when behavior changes
Full guide: CONTRIBUTING.md.