hermes-kanban-miniapp/CONTRIBUTING.md
2026-07-09 17:19:33 +03:00

785 B

Contributing

Thanks for helping improve Hermes Kanban Mini App.

Development

  1. Fork or clone the repository.
  2. Copy .env.example to .env and use local/dev values only.
  3. Run backend tests with cd backend && ../.venv/bin/pytest or create your own venv.
  4. Run frontend tests with cd frontend && npm test.
  5. Run npm run build before opening a PR.

Pull requests

  • Keep changes focused.
  • Add or update tests for behavior changes.
  • Do not commit .env, bot tokens, chat IDs, personal hostnames, or private board data.
  • Prefer fixed Hermes Kanban CLI actions over generic command execution.

Code style

  • Backend: typed Python, FastAPI, Pydantic models for request validation.
  • Frontend: React + TypeScript, mobile-first UI, no heavy Telegram SDK lock-in.