docs: overhaul README, CONTRIBUTING, and SECURITY (#833)

README: rewrite to lead with differentiation rather than a flat
feature list. Add "Why Sencho?" section covering the four key
competitive advantages (Pilot Agent NAT traversal, auto-heal
self-healing, atomic deployments, automation-first model). Expand
feature coverage from 8 bullets to six grouped domains reflecting
the full 38-feature surface. Add architecture note, docker run
one-liner, tier comparison table (Community/Skipper/Admiral), and
docs link section. Drop stale CI badge; add Docker Pulls badge.

CONTRIBUTING: add project layout reference, tier-gate usage guide,
TypeScript strictness reminder, and pointer to CLAUDE.md for full
coding standards.

SECURITY: update supported versions table from stale "0.2.x+" to
current "latest release" policy with a note on self-hosted update
cadence.
This commit is contained in:
Anso
2026-04-28 12:29:48 -04:00
committed by GitHub
parent 8d3fc1bc77
commit bb50bed071
3 changed files with 160 additions and 20 deletions
+38 -3
View File
@@ -18,12 +18,47 @@ Thank you for your interest in contributing to Sencho!
cd frontend && npm run dev # Vite on :5173
```
## Project Layout
```
backend/
src/
routes/ # One router per feature group (stacks, nodes, fleet, ...)
services/ # Business logic singletons (ComposeService, DockerController, ...)
middleware/ # Auth, tier gates, audit log, node context
websocket/ # Upgrade handlers for log streaming, host console, proxy tunnels
frontend/
src/
components/ # Page-level and shared UI components
context/ # Auth, node selection, and other React contexts
hooks/ # Shared React hooks
lib/ # apiFetch wrapper and other utilities
```
Read [CLAUDE.md](CLAUDE.md) for full coding standards, architecture rules, and the pre-commit checklist.
## Development
- **Backend:** Node.js + Express + TypeScript in `backend/`
- **Frontend:** React 19 + Vite + TypeScript in `frontend/`
- **Tests:** `cd backend && npm test` (Vitest) and `npm run test:e2e` (Playwright)
- **Lint:** `npm run lint` in both `backend/` and `frontend/`
- **Type check:** Run `cd backend && npx tsc --noEmit` (and the frontend equivalent) before every commit. The CI build will reject type errors.
## TypeScript Standards
The project uses `strict: true`. Write code that compiles without `any` casts or `@ts-ignore`. If a library lacks types, import `@types/...` or use `unknown` with narrowing.
## Tier-Gated Features
Sencho has three tiers: Community, Skipper, and Admiral. If your change adds a feature that belongs behind a tier gate, use the guards from `backend/src/middleware/tierGates.ts`:
```typescript
if (!requirePaid(req, res)) return; // Skipper and above
if (!requireAdmiral(req, res)) return; // Admiral only
```
Call the guard at the top of the route handler with an early return. Both guards handle proxy-forwarded tier headers automatically.
## Pull Request Process
@@ -32,8 +67,8 @@ Thank you for your interest in contributing to Sencho!
- Use [Conventional Commits](https://www.conventionalcommits.org/) for commit messages
- Update documentation if your change affects user-facing behavior
- Add tests for new functionality
- Keep PRs focused - one feature or fix per PR
- Do not edit `CHANGELOG.md` directly. It is generated from your conventional-commit subjects by release-please. If a user-facing change needs more context than the commit subject captures, enrich the auto-opened Release PR description before it is merged.
- Keep PRs focused: one feature or fix per PR
- Do not edit `CHANGELOG.md` directly. It is generated from conventional-commit subjects by release-please. If a user-facing change needs more context, enrich the auto-opened Release PR description before merging.
## Reporting Bugs
@@ -41,7 +76,7 @@ Use the [bug report template](https://github.com/AnsoCode/Sencho/issues/new?temp
## Code Style
- TypeScript with `strict: true` - no `any` casts or `@ts-ignore`
- TypeScript with `strict: true`: no `any` casts or `@ts-ignore`
- ESLint 9 flat config for both backend and frontend
- Tailwind CSS + shadcn/ui for frontend styling
- Follow existing patterns in the codebase