Home

dev / openkara

publicthedavidweng/OpenKara· sync paused
Overview Code History Branches Pull requestsIssuesInsights
main
HomeOverview Code PRsIssues

docs: correct the developer-facing docs that had drifted (#275)

2 months ago

793cbe9
Authored
Davy7/26/2026, 10:36:13 PM
The pull request template was a Go project's - go test -race, go vet,
gofmt, and a --json CLI contract that does not exist here. Replaced with
the checks this repo actually runs.

README and README_CN claimed pnpm 10+; package.json pins pnpm@11.13.0
and requires ">=11 <12", so following the README could not install.

README_CN was missing five features README lists - streaming playback,
remote repositories, playlists and singer rotation, lyrics romanization,
and AirPlay casting. Both lists are 17 entries now.

CONTRIBUTING described only cargo clippy / cargo fmt / cargo test. It
never mentioned the frontend commands, nextest, the i18n check, the
contract-doc rule, that the git hooks already run most of it, or
./scripts/setup.sh, which local dev needs.

Parenta5bda41

4 files changed
  • .github/PULL_REQUEST_TEMPLATE.md+8−5
  • CONTRIBUTING.md+24−15
  • README.md+2−2
  • README_CN.md+7−2