MT015: HasFundingInfo

Overview

Property Value
ID MT015
Name HasFundingInfo
Group metadata
Severity NOTE

Description

Checks that a FUNDING.yml file exists to let users know how to support your project.

Funding information helps:

  • Users discover ways to support your work
  • GitHub display sponsor buttons on your repository
  • Encourage sustainable open source development

What it checks

The check looks for a FUNDING.yml file in these locations:

  • .github/FUNDING.yml (GitHub standard location)
  • FUNDING.yml (project root)

How to fix

Create a FUNDING.yml file in your .github/ directory:

# .github/FUNDING.yml

# GitHub Sponsors username
github: username

# Other funding platforms
patreon: username
open_collective: project-name
ko_fi: username
tidelift: npm/package-name
custom: ["https://www.buymeacoffee.com/username"]

Available platforms

GitHub supports these funding platforms:

  • github - GitHub Sponsors
  • patreon - Patreon
  • open_collective - Open Collective
  • ko_fi - Ko-fi
  • tidelift - Tidelift
  • community_bridge - Community Bridge
  • liberapay - Liberapay
  • issuehunt - IssueHunt
  • lfx_crowdfunding - LFX Crowdfunding
  • polar - Polar
  • buy_me_a_coffee - Buy Me a Coffee
  • custom - Custom URLs (array of up to 4 URLs)

Minimal example

# .github/FUNDING.yml
github: your-username

Configuration

Skip this check

[tool.pycmdcheck]
skip = ["MT015"]

CLI

pycmdcheck --skip MT015