Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (44 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

56 lines (44 loc) · 2.2 KB
Raw

Contributing

Thanks for interest in ask-question-mcp (GPLv3-or-later).

Development

git clone https://github.com/DynamicDevices/ask-question-mcp.git
cd ask-question-mcp
uv sync
uv run python scripts/test_match_transcript.py
uv run python scripts/test_doctor.py
uv run python scripts/test_acks.py
uv run python scripts/test_install.py
uv run python scripts/test_dialog_ergonomics.py
uv run python scripts/test_windows_backend.py
uv run python scripts/test_contracts.py
uv run python scripts/test_mcq_images.py

Optional voice: set ASK_QUESTION_TTS_URL and ASK_QUESTION_STT_URL to your own HTTP services (see SETUP.md). Never commit tokens or prefs.json.

Dialog keyboard / geometry behaviour for humans: docs/AGENTS.md — Dialog UX.

Pull requests

  • Use the PR template (hosts touched, test table, behaviour contract).
  • CI must pass: test, secrets-hygiene (and sbom). Same-repo hygiene/SBOM run on DynamicDevices self-hosted Linux; external fork PRs use GitHub-hosted so untrusted code does not run on lab runners.
  • Keep diffs focused; match existing style.
  • Do not add hardcoded private IPs, home-directory paths, or credentials.
  • New features that talk to the network should fail closed when URLs/tokens are unset.
  • By contributing, you agree your changes are licensed under GPL-3.0-or-later.

Platform feedback

Please help keep the Tested platforms table honest:

  • Issue or PR with: distro + version, desktop (GNOME/KDE/…), audio stack, MCP client, and what worked (text MCQ / speak / duck / STT).
  • Prefer updating the README table in the same PR when you verify a new row.
  • Use Verified / Partial / Not yet reported / Unsupported — do not mark Verified without a real interactive dialog test.
  • On unverified desktops the MCP prompts once via ask_multiple_choice (platform_feedback); agents should draft the GitHub issue body from the auto-filled host fields. Mute with ASK_QUESTION_PLATFORM_FEEDBACK=0 or choose “Don’t ask again” (record_platform_feedback).

Security

See SECURITY.md. Do not file public issues for vulnerabilities.