mirror of https://github.com/Studio-Saelix/sencho.git synced 2026-07-26 11:49:16 +00:00

Files

T

Anso 9b3f5c5a90 docs: relicense Sencho to AGPLv3 and reframe Community positioning (#1623 )

* docs: relicense Sencho to AGPLv3 and reframe Community positioning

Replace BSL with AGPLv3 for the public Community product, update contributor
and licensing copy for Community-focused contributions, and surface source
and license links in Settings About.

* docs: clarify CLA scope and Community contribution framing

* fix(ui): split About link constants and harden AboutSection test selectors

2026-07-13 03:49:29 -04:00

3.4 KiB

Raw Blame History

Contributing to Sencho

Thank you for your interest in contributing to Sencho!

Getting Started

Fork the repository
Clone your fork: git clone https://github.com/YOUR_USERNAME/sencho.git
Create a branch: git checkout -b feature/your-feature

Install dependencies:

cd backend && npm install
cd ../frontend && npm install

Start the dev servers:

cd backend && npm run dev    # Express + nodemon on :1852
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, 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

See the rest of this file for the most important contributor-facing standards (TypeScript, PR process, code style). Architecture and module layout deep-dives live in the project documentation at docs.sencho.io.

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.

Contributing to Community

This public repository is the AGPLv3 Community product. Contributions here stay under AGPLv3 for the Community product. We will not take a Community contribution and move it behind a paid gate.

You will be required to sign our Contributor License Agreement (CLA) when you open your first Pull Request.

Trademarks

Sencho and Studio Saelix names and logos are trademarks. AGPLv3 does not grant trademark rights. See TRADEMARKS.md.

Pull Request Process

All PRs target main
Ensure CI passes before requesting review
Use Conventional Commits 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 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

Use the bug report template. Include: deployment method, Sencho version, browser (for UI issues), steps to reproduce, and expected vs actual behavior.

Code Style

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

3.4 KiB Raw Blame History