Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (53 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

73 lines (53 loc) · 2.89 KB
Raw

Contributing to DiscEcho

Welcome, and thanks for looking. DiscEcho is a self-hosted homelab service that watches optical drives, classifies inserted discs, and runs per-disc- type rip → transcode → tag → move pipelines, fronted by a mobile-first web UI. The README's "How it works" section sketches the system shape; the code under daemon/ and webui/ is the rest.

Dev setup

See the README for the full setup and command reference. In short: you need Go, Node, Docker, and a Linux host with at least one optical drive at /dev/sr0.

Branching and commits

  • Trunk-based. Short-lived feature branches off main, named <type>/<short-desc> (e.g. feat/audiocd-pipeline, fix/udev-races).
  • Conventional Commits: feat:, fix:, chore:, docs:, refactor:, test:, ci:, perf:, build:. The PR title is the squashed commit message — keep it imperative and under ~70 characters.
  • PRs squash-merge into main. Branch protection blocks direct pushes and requires CI green.
  • AI-assisted commits are fine — a lot of this fork is built with Claude Code — and a Co-Authored-By:/session trailer on those commits is welcome, not required. What matters is the commit message itself explaining the real why, not just restating the diff.

Code style

Defer to .editorconfig and the language formatters:

  • Go: gofmt (or goimports) on save. go vet clean.
  • SvelteKit / TypeScript / CSS / JSON / YAML / Markdown: prettier.
  • Other: respect .editorconfig.

No ESLint/Go-lint rule is sacred — if it makes the code worse, file an issue and we'll discuss.

Testing

Every PR that changes behaviour includes or updates tests. CI runs typecheck + lint + the full test suite on every push, and must be green before a PR can merge. Don't disable tests to make CI pass — fix the underlying problem, or say so explicitly in the PR.

Filing issues

Bugs: include your environment (OS, kernel, Docker version), drive model + bus, disc type and (if applicable) the title, exact steps to reproduce, and the relevant daemon log lines.

Feature requests: lead with the use case ("when I rip a [...], I want [...] because [...]") and only then propose a solution. We're more likely to merge a small change to a real problem than a big change to a guessed one.

Good first issues

Issues tagged good first issue are small, well-scoped, and a fine entry point. Bug reports and "have you considered…" feature ideas are all useful contributions, even if you're not writing code.

License

DiscEcho is released under the MIT License. By contributing you agree that your contributions are licensed under the same terms. A Signed-off-by: trailer (git commit -s) is welcome but not required.

Code of conduct

Be kind, assume good faith, and stay focused on the work.