DEV Community πŸ‘©β€πŸ’»πŸ‘¨β€πŸ’»

Burdette Lamar
Burdette Lamar

Posted on

Tags, Anyone?

It's come to the attention of the newly-appointed Tag Moderators (I have #markdown) that the Top 100 Tags page has "discoverability issues."

Discover away!

Top comments (1)

Collapse
 
itsasine profile image
ItsASine (Kayla)

Oh man, now I know my tags are popular. Need to put more work into sidebars now :)

Timeless DEV post...

How to write a kickass README

Arguably the single most important piece of documentation for any open source project is the README. A good README not only informs people what the project does and who it is for but also how they use and contribute to it.

If you write a README without sufficient explanation of what your project does or how people can use it then it pretty much defeats the purpose of being open source as other developers are less likely to engage with or contribute towards it.