docs icon indicating copy to clipboard operation
docs copied to clipboard

Explicitly state that default community health files won’t appear in the file browser or Git history for each repository

Open GuySartorelli opened this issue 1 year ago • 2 comments

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file

What changes are you suggesting?

Explicitly state that default community health files won’t appear in the file browser or Git history for each repository.

As written, the documentation seems to imply that the files would be visible in the GitHub file browser. This tripped up my team recently; it was only after adding the default files that we learned this wasn't the case and it took a fair bit of digging to find out that this is intended.

Hopefully having this explicitly stated will help others avoid this misunderstanding.

Additional information

No response

GuySartorelli avatar Jun 26 '23 04:06 GuySartorelli

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Jun 26 '23 04:06 welcome[bot]

@GuySartorelli Thank you for opening an issue and linking it to your PR! ✨

cmwilson21 avatar Jun 26 '23 14:06 cmwilson21