Skip to content

Add GitHub Funding Configuration #97

Description

@JeremyDev87

Add GitHub Funding Configuration

Summary

Create a .github/FUNDING.yml file to enable GitHub Sponsors and other funding options for the project.

Problem

  • No funding configuration exists for the project
  • Contributors who want to financially support the project have no clear way to do so
  • GitHub Sponsors button is not displayed on the repository page
  • Sustainable open source maintenance requires funding options

Solution

Create a .github/FUNDING.yml file to configure funding platforms.

Implementation Details

File to Create

Path: .github/FUNDING.yml

Content Options

Choose the appropriate funding platforms:

# GitHub Sponsors
github: [JeremyDev87]

# Other platforms (uncomment as needed)
# patreon: username
# open_collective: codingbuddy
# ko_fi: username
# tidelift: npm/codingbuddy
# community_bridge: codingbuddy
# liberapay: username
# issuehunt: JeremyDev87
# lfx_crowdfunding: codingbuddy
# polar: JeremyDev87

# Custom funding URL
# custom: ['https://example.com/sponsor']

Minimal Configuration

If only GitHub Sponsors is needed:

github: [JeremyDev87]

Full Configuration Example

github: [JeremyDev87]
ko_fi: codingbuddy
custom: ['https://www.buymeacoffee.com/codingbuddy']

Prerequisites

Acceptance Criteria

  • .github/FUNDING.yml file exists
  • At least one funding platform is configured
  • "Sponsor" button appears on the repository page
  • Funding links are valid and working
  • YAML syntax is valid

Labels

documentation, community

Priority

Low - Optional enhancement for project sustainability

Notes

This is an optional feature. The maintainer should decide:

  1. Whether to enable funding
  2. Which platforms to use
  3. Whether to set up GitHub Sponsors account first

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions