mirror of
https://github.com/Dvorinka/Dash.git
synced 2026-10-28 07:41:27 +00:00
Tomas DvorakandDevin
afa0c931b9
Restructure README to the standard OSS layout (logo, badges, screenshots grid, architecture, quick start). Add install.sh for curl|sh installs with a named-volume fallback for Docker Desktop file-sharing limits, and scripts/setup.sh for clone-based setup. Correct SECURITY.md (no longer pre-1.0) and CONTRIBUTING.md (auth shipped in 2.0.0). Authored By: TDvorak <[email protected]> Generated with [Devin](https://devin.ai) Co-Authored-By: Devin <158243242+devin-ai-integration[bot]@users.noreply.github.com>
61 lines
1.8 KiB
Markdown
61 lines
1.8 KiB
Markdown
# Contributing
|
|
|
|
Thanks for considering a contribution. Dash is a small, deliberate codebase —
|
|
read [AGENTS.md](AGENTS.md) and [ROADMAP.md](ROADMAP.md) first; the roadmap is
|
|
canonical for what gets built and when.
|
|
|
|
## Setup
|
|
|
|
Requires Go 1.24+ and Node 20+.
|
|
|
|
```sh
|
|
npm install
|
|
npm run generate # regenerate the TS client from openapi.yaml
|
|
npm run dev # vite dev server on :5173, proxies /api to :8080
|
|
```
|
|
|
|
```sh
|
|
cd apps/backend
|
|
DASH_DEV=1 go run ./cmd/dash # API on :8080
|
|
```
|
|
|
|
## Rules of the house
|
|
|
|
- `openapi.yaml` is the API contract. Change it first, then
|
|
`npm run generate`. Never hand-write API types in the frontend.
|
|
- All schema changes go through goose migrations in
|
|
`apps/backend/internal/db/migrations` — `NNNN_name.sql` with `-- +goose Up`
|
|
and `-- +goose Down`.
|
|
- Board renderers share state, drag-drop, and popover primitives. Never
|
|
reimplement them per renderer.
|
|
- Auth is opt-in and local-only: no OIDC/SSO, no multi-user RBAC. No
|
|
YAML-as-source-of-truth, no external database. These are non-goals.
|
|
- Standard library before dependencies; existing helpers before new ones.
|
|
- User-visible strings go through `t("key")` from `src/i18n` — add the key to
|
|
`en.ts` rather than inlining literals in new UI.
|
|
|
|
## Before pushing
|
|
|
|
```sh
|
|
npm run typecheck
|
|
npm run lint
|
|
npm run build
|
|
|
|
cd apps/backend
|
|
go build ./... && go vet ./... && go test ./...
|
|
```
|
|
|
|
Plus a real smoke test of whatever you changed. All gates green or no push.
|
|
|
|
## Commits and PRs
|
|
|
|
- Conventional-ish subjects: `feat:`, `fix:`, `docs:`, `refactor:` — keep them
|
|
short and describe the why.
|
|
- Small, reviewable PRs. Fill in the template; a screenshot of UI changes is
|
|
worth more than a paragraph.
|
|
|
|
## Reporting bugs / requesting features
|
|
|
|
Use the issue templates. For security issues, see
|
|
[SECURITY.md](SECURITY.md) — do not open a public issue.
|