Create FUNDING.yml - #1
canstralian wants to merge 1 commit into
Conversation
Signed-off-by: WhacktheJacker <8595080+canstralian@users.noreply.github.com>
Reviewer's GuideA new File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Pull Request Overview
This pull request adds a new FUNDING.yml configuration file to define supported funding platforms and associated usernames for sponsorship opportunities.
- Adds FUNDING.yml with configuration entries for GitHub, Patreon, Buy Me a Coffee, and several other platforms.
- Provides placeholder comments for platforms that need customization.
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
Hey @canstralian - I've reviewed your changes - here's some feedback:
- Consider removing placeholder entries for funding platforms not currently in use to keep the
FUNDING.ymlconcise and focused on active sponsorship options.
Here's what I looked at during the review
- 🟢 General issues: all looks good
- 🟢 Security: all looks good
- 🟢 Testing: all looks good
- 🟢 Complexity: all looks good
- 🟢 Documentation: all looks good
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
![hoji-ai[bot]](https://avatars.githubusercontent.com/in/358158?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary
- Added a .github/FUNDING.yml file to configure funding options.
- Defined GitHub sponsor username as 'canstralian'.
- Defined Patreon username as 'canstralian'.
- Added placeholders for other funding platforms like Open Collective, Ko-fi, Tidelift, and more.
Review
The funding configuration file (.github/FUNDING.yml) is introduced, including placeholders for multiple funding platforms. Important funding platforms like GitHub sponsors and Patreon are filled, while others remain as placeholders and need updating or removal if unused.
|
|
||
| github: canstralian | ||
| patreon: canstralian | ||
| open_collective: # Replace with a single Open Collective username |
There was a problem hiding this comment.
A placeholder for the Ko-fi username has been left here. It should be replaced with the intended username or removed if not in use.
| github: canstralian | ||
| patreon: canstralian | ||
| open_collective: # Replace with a single Open Collective username | ||
| ko_fi: # Replace with a single Ko-fi username |
There was a problem hiding this comment.
Ensure that the Tidelift information is updated correctly. This placeholder needs to be replaced to reflect the actual supported package.
| patreon: canstralian | ||
| open_collective: # Replace with a single Open Collective username | ||
| ko_fi: # Replace with a single Ko-fi username | ||
| tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel |
There was a problem hiding this comment.
The Community Bridge project name is currently a placeholder. Update it with the correct project name or remove this entry if it's not applicable.
| open_collective: # Replace with a single Open Collective username | ||
| ko_fi: # Replace with a single Ko-fi username | ||
| tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
| community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry |
There was a problem hiding this comment.
Liberapay username is set as a placeholder. Replace this with the appropriate username to enable funding through Liberapay.
| ko_fi: # Replace with a single Ko-fi username | ||
| tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
| community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
| liberapay: # Replace with a single Liberapay username |
There was a problem hiding this comment.
The IssueHunt username is currently empty. Update it with the intended username to allow funding or remove it if not in use.
| tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel | ||
| community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
| liberapay: # Replace with a single Liberapay username | ||
| issuehunt: # Replace with a single IssueHunt username |
There was a problem hiding this comment.
Ensure that the LFX Crowdfunding project name is replaced with correct details or remove this placeholder if it's not required.
| community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry | ||
| liberapay: # Replace with a single Liberapay username | ||
| issuehunt: # Replace with a single IssueHunt username | ||
| lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry |
There was a problem hiding this comment.
Polar username should be updated from the placeholder to the correct username for proper integration.
| issuehunt: # Replace with a single IssueHunt username | ||
| lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry | ||
| polar: # Replace with a single Polar username | ||
| buy_me_a_coffee: sadejager |
There was a problem hiding this comment.
Replace the placeholder for 'thanks_dev' with the actual username or remove it if not planning to use this funding platform.
| lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry | ||
| polar: # Replace with a single Polar username | ||
| buy_me_a_coffee: sadejager | ||
| thanks_dev: # Replace with a single thanks.dev username |
There was a problem hiding this comment.
The 'custom' field allows for up to 4 URLs. If custom sponsorships are in use, replace placeholders with the correct URLs; otherwise, this field may be unnecessary.
|
Qodo Merge was enabled for this repository, but no eligible user found. Please link your Git account with your Qodo account here. |
This pull request adds a new
.github/FUNDING.ymlfile to specify supported funding platforms and associated usernames for sponsorship opportunities.Funding configuration:
.github/FUNDING.yml: Introduced a funding configuration file with entries for platforms like GitHub, Patreon, Ko-fi, and Buy Me a Coffee. Some placeholders are included for other platforms, allowing customization with specific usernames or URLs.Summary by Sourcery
Add GitHub FUNDING.yml to support project sponsorship platforms
New Features:
Documentation: