readme-best-practices

readme-best-practices copied to clipboard

Features to the top

2

Why features are not right after the name and description? From perspective of viewer I want to know what it is first and then how to use or contribute. So...

Masyaka

It can be important for the reader to know about the motivations of a project (why this project has come into existence)

jehna

Billie Thompson has a good readme template here: https://gist.github.com/PurpleBooth/109311bb0361f32d87a2 Check it for any additional sections. Also this repository's own README could have a reference to that readme template (among others),...

jehna

Developing vs Contributing?

2

What's the difference between what should be included in the "Developing" section versus the "Contributing" section? Aren't those essentially the same things?

nikhiltri

For visibility, should be added to: https://github.com/matiassingers/awesome-readme/blob/master/readme.md

jehna

Table of Contents

1

From proposal of @lehtu: > [ToC] would be nice to have, especially when you have a long README

jehna