SUPPORT.md

aid: support-md
name: SUPPORT.md
description: >-
  SUPPORT.md is a GitHub community health file that describes how users can get
  help with an open source project. When present in a repository root or .github/
  directory, GitHub automatically links to it from issue creation flows, directing
  users to appropriate support channels before filing bugs.
type: Index
image: https://kinlane-productions.s3.amazonaws.com/apis-json/apis-json-logo.jpg
tags:
  - Community
  - Documentation
  - GitHub
  - Open Source
  - Repository
  - Support
url: https://raw.githubusercontent.com/api-evangelist/support-md/refs/heads/main/apis.yml
created: '2025-01-01'
modified: '2026-05-02'
specificationVersion: '0.19'
apis:
  - aid: support-md:github-community-health-files-api
    name: GitHub Community Health Files API
    description: >-
      GitHub provides REST API endpoints for retrieving and validating community
      health files in repositories, including SUPPORT.md, CONTRIBUTING.md,
      CODE_OF_CONDUCT.md, and related governance documents.
    humanURL: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project
    baseURL: https://api.github.com
    tags:
      - Community
      - GitHub
      - Health Files
      - Open Source
      - Support
    properties:
      - type: Documentation
        url: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project
      - type: GitHub Blog
        url: https://github.blog/2017-07-20-support-file-support/
common:
  - type: Website
    url: https://docs.github.com/en/communities
  - type: Documentation
    url: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions
  - type: GitHub
    url: https://github.com/github/docs
  - type: Blog
    url: https://github.blog/2017-07-20-support-file-support/
  - type: Specification
    url: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project
maintainers:
  - FN: Kin Lane
    email: [email protected]