Skip to content

Clarify FUNDING.yml storage locations - #46873

Closed
JBallin wants to merge 1 commit into
github:mainfrom
JBallin:patch-1
Closed

JBallin wants to merge 1 commit into
github:mainfrom
JBallin:patch-1

Conversation

@JBallin

@JBallin JBallin commented Nov 8, 2026 •

Copy link
Copy Markdown

Why:

Homebrew’s default community files repository has FUNDING.yml at 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.yml can be placed in docs, as well as the root or .github. Is the docs location supported too, or should the wording distinguish it?

Update: I tested docs/FUNDING.yml in a .github repository. The Sponsor button was still visible on another repository a few minutes later, though caching may explain it.

What's being changed:

Remove FUNDING.yml from the instruction to store specific files in the .github folder.

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the review environment.

Removed 'FUNDING.yml' from the list of community health files to store in the '.github' folder.
Copilot AI lite review requested due to automatic review settings November 8, 2026 02:46
@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Nov 8, 2026
@github-actions

github-actions Bot commented Nov 8, 2026

Copy link
Copy Markdown
Contributor

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 links

Note: Please update the URL for your staging server or codespace.

The table shows the files in the content directory that were changed in this pull request. This helps you review your changes on a staging server. Changes to the data directory are not included in this table.

Source Review Production What Changed
communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md fpt
ghec
ghes@ 3.22 3.21 3.20 3.19
fpt
ghec
ghes@ 3.22 3.21 3.20 3.19

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server

🤖 This comment is automatically generated.

@JBallin JBallin changed the title Update community health file storage instructions Clarify FUNDING.yml storage locations Nov 8, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 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.yml from the .github-specific instruction.
  • Keeps vulnerability report files restricted to .github.
  • Requires clarification so the guidance does not imply that docs/FUNDING.yml is 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 %}
@davismountaindaniel-create

This comment was marked as off-topic.

@github github deleted a comment from Ice1984m Nov 9, 2026
@subatoi

subatoi commented Nov 9, 2026

Copy link
Copy Markdown
Contributor

@JBallin Thanks for your submission.

Could you confirm whether the root location is supported

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.

@subatoi subatoi closed this Nov 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

triage Do not begin working on this issue until triaged by the team

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants