Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (26 loc) · 828 Bytes

CONTRIBUTING.md

File metadata and controls

35 lines (26 loc) · 828 Bytes
Raw

Contributing

Thank you for contributing to Cotux.

Rules

  • Do not add scraping, private APIs, or reverse engineering.
  • Keep commits atomic and focused.
  • Update docs/implementation-journal.md when a meaningful milestone is completed.
  • Record architectural decisions in docs/adr/.

Development

npm install
npm run fetch:runtime
npm run tauri dev

Tests

npm run validate:runtime
npm test
cd src-tauri && cargo test
npm run build

Release (maintainers)

  1. Complete docs/e2e-checklist.md
  2. Run ./scripts/build-release.sh
  3. Configure GitHub remote: git remote add origin https://github.com/<org>/cotux.git
  4. Tag: ./scripts/tag-release.sh v0.1.0 then git push origin v0.1.0
  5. CI uploads AppImages, SBOM, and cosign signatures to the GitHub Release