3 ms·
README files is the first thing I read in any source code repository. I’m noticing a trend of less useful readmes in projects. Often they are bare or provide
by bitmasher9 3y ago
README files is the first thing I read in any source code repository. I’m noticing a trend of less useful readmes in projects. Often they are bare or provide outdated and incorrect information. This makes the introduction to the source code harder, and increases the barrier for new contributors.
- logro 3y agoAbsolutely. Over the years countless projects have missed contributions from me because of a bad README.
- vrighter 3y agothe worst readmes are those that say "this is a fork of blablabla" Ok, but what do you do? what have you changed? Need any dependencies? How do I build? at the very least just copy the old readme and add a note on top. And please please keep it updated