Skip to content

SUPPORT.md

Latest commit

 

History

History
52 lines (38 loc) · 1.03 KB

SUPPORT.md

File metadata and controls

52 lines (38 loc) · 1.03 KB
Raw

Support

CheckYourself is a free, local-first open-source project.

Best Support Path

Use GitHub Issues for:

  • bugs;
  • confusing documentation;
  • broken CLI or MCP behavior;
  • accessibility problems;
  • stale dashboard screenshots or examples;
  • requests for adapter docs.

Use the issue title to name the surface:

CLI: describe output is missing a schema
MCP: tools/list fails in my client
Docs: README says future tense but code already shipped
Dashboard: screenshot is stale

What To Include

Please include:

  • CheckYourself version or commit;
  • AI tool or MCP client, if relevant;
  • command you ran;
  • expected behavior;
  • actual behavior;
  • redacted output only.

Do not include live credentials, private customer data, proprietary code, or unredacted .env values.

Maintainer Triage

Suggested labels:

  • bug;
  • docs;
  • cli;
  • mcp;
  • accessibility;
  • security;
  • question.

The first response should identify whether the report is a real defect, missing evidence, a docs gap, or an accepted limitation.