Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (20 loc) · 927 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (20 loc) · 927 Bytes
Raw

Contributing

Thanks for improving Link2News. This is a macOS-first, single-user self-hosted project. Keep changes inside that boundary unless an issue has explicitly accepted a larger design.

Development setup

./scripts/bootstrap.sh
.venv/bin/python -m unittest discover -s tests -p 'test_*.py'
npm test
bash scripts/check_public_tree.sh

Never use production LINE, Cloudflare, LLM, or voice credentials in tests. Fixtures must be synthetic or redistributable. Add tests for behavior changes, run git diff --check, and update the relevant user/API documentation.

Pull requests

  • Keep one coherent change per PR.
  • Explain user impact, migration, verification, and rollback.
  • Call out schema, API, security, provider-cost, or data-retention changes.
  • Do not commit generated reports, papers, logs, configuration, or secrets.

By contributing, you agree that your contribution is licensed under MIT.