Autodetect CONTRIBUTING.md files

Hello there. 👋

Not sure if this is the correct place to suggest this :thinking: , but let’s do it anyway. :slightly_smiling_face:

Contributing files are a big part of open-source projects, it would be nice if it was automatically detected like our README’s and LICENSE files and added to the sidebar for quick and easy access.

Something like this maybe? :thinking:

Contributing section added to sidebar

What does everybody else think about this? :slightly_smiling_face:

1 Like

We do already autodetect CONTRIBUTING files and surface them in various ways. For example, when opening a new issue or PR if you haven’t viewed the CONTRIBUTING guide (or other community health files) before or if they’ve been updated you’ll get a callout in the sidebar:

Additionally, even if they haven’t been updated recently, there are reminders like this:

Research has shown that these kind of “just in time” reminders or notifications are often more effective than offering links in places where there’s less of a contextual relationship.

However, we’re always looking to improve the GitHub platform, so I’ll pass along your feedback to the appropriate team. I can’t make any promises as to if or when it might happen, but you can rest assured the right people will hear your feedback.

Thanks for your passion and interest in GitHub!

2 Likes