Repository navigation
Conversation
Removed 'FUNDING.yml' from the list of community health files to store in the '.github' folder.
How to review these changes 👓Thank you for your contribution. To review these changes, choose one of the following options: A Hubber will need to deploy your changes internally to review. Table of review linksNote: Please update the URL for your staging server or codespace. The table shows the files in the
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server 🤖 This comment is automatically generated. |
There was a problem hiding this comment.
🟡 Changes recommended
The documentation incorrectly implies that a default FUNDING.yml may be placed in docs, so the file-location guidance needs correction.
1 open issue
What changed in this PR
This pull request updates the guidance for storing default community health files, removing FUNDING.yml from the .github-only file list.
Changes:
- Removes
FUNDING.ymlfrom the.github-specific instruction. - Keeps vulnerability report files restricted to
.github. - Requires clarification so the guidance does not imply that
docs/FUNDING.ymlis supported.
| File | Summary |
|---|---|
content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md |
Updates storage-location guidance; the current wording may incorrectly imply that FUNDING.yml is supported in docs. |
This pull request requires changes.
Review effort: Lite
| * Store discussion category forms in `.github/DISCUSSION_TEMPLATE`. | ||
| * Store issue templates and their configuration file in `.github/ISSUE_TEMPLATE`. | ||
| {% ifversion fpt or ghec %}* Store `FUNDING.yml`, `VULNERABILITY_REPORT.yml`, and `VULNERABILITY_REPORT.yaml` in the `.github` folder.{% endif %} | ||
| {% ifversion fpt or ghec %}* Store `VULNERABILITY_REPORT.yml` and `VULNERABILITY_REPORT.yaml` in the `.github` folder.{% endif %} |
This comment was marked as off-topic.
This comment was marked as off-topic.
|
@JBallin Thanks for your submission.
As this is not something you've definitively confirmed yourself, this repo isn't the right place for this, and I'd invite you to open a ticket with GitHub Support if your package includes it, or if not, you're welcome to open a discussion under https://github.com/orgs/community/discussions The latter would actually be the perfect place for this, since it actually relates to communities content. If/when it's confirmed, the team there will advise us of the need for a change. Sorry this won't have been the outcome you were hoping for, but I'm going to close this out. Thanks for your interest in the GitHub docs. |

Why:
Homebrew’s default community files repository has
FUNDING.ymlat its root, and Homebrew/brew displays a Sponsor button. This suggests the root location may work for default funding files.Could you confirm whether the root location is supported? This edit would also imply that
FUNDING.ymlcan be placed indocs, as well as the root or.github. Is thedocslocation supported too, or should the wording distinguish it?Update: I tested
docs/FUNDING.ymlin a.githubrepository. The Sponsor button was still visible on another repository a few minutes later, though caching may explain it.What's being changed:
Remove
FUNDING.ymlfrom the instruction to store specific files in the.githubfolder.Check off the following: