Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

SUPPORT.md

File describing how users can get help with a project, including links to documentation, forums, issue trackers, and support channels.

SUPPORT.md is a convention-driven repository file that tells people how to get help with a project. Platforms like GitHub recognize it specially: when a SUPPORT.md exists, a “Support” link surfaces in the issue and pull-request flow, steering users toward the right channel instead of opening low-quality issues. It is a small, low-cost document that answers one question — where do I go when I’m stuck? — and answers it in a predictable place.

  • A known location - Lives at the repository root (or .github/), so both humans and tooling can find it without guessing.
  • Channel routing - Points to docs, forums, chat, mailing lists, or paid support, keeping the issue tracker focused on actual bugs.
  • Platform-aware - GitHub and similar hosts wire it into their contribution UI automatically once present.
  • Community hygiene - Sits beside CONTRIBUTING.md and CODE_OF_CONDUCT.md as part of a healthy project’s baseline documentation.

In real API operations, a SUPPORT.md is one of the cheapest signals that a provider takes its developer relationship seriously — it separates “file a GitHub issue” from “email sales” from “read the docs” before a frustrated integrator has to ask. Alongside a README.md and CODEOWNERS, it is part of the repository-level metadata that both onboarding humans and, increasingly, agents scan to understand how a project expects to be engaged.