Feature proposal: README.md from GH repositories

[mekline]

Steps

1. Link an OSF repository to an existing github repository (that's it)

Expected

The README.md file should bubble up to the OSF component so that creators don't have to duplicate that information into the Description field, and so that users automatically see this info.

Actual

You have to navigate to and view the README.md file, which takes a bit of time to appear as OSF loads the whole filestructure of the repository (or whatever it is that causes this delay between selecting & viewing files...)

You also have to be a person who knows that this is a good place to look for that kind of thing; even if the filename is obvious, OSF users are confronted with a lot of way more prominent information telling them how to understand what they're looking at.

[Johnetordoff]

Thanks for the feedback, the problem with doing this that an "OSF repository" or node, (also sometimes referred to as a component or project) can link to multiple addons, Github, Dropbox, Google Drive, our own OSFStorage etc. So automatically making the description field the Github Readme.md would impede user experience for people use multiple file storage addons or users don't think the Readme.md really describes the totality of their project or component in a valuable way.

However that's just my two cents, it would be interesting to hear what my fellow developers and product team feel about this.