A crash course on writing a better #readme
▻https://hackernoon.com/a-crash-course-on-writing-a-better-readme-d796d1f6b352?source=rss----3a8
In the wake of the Hacktoberfest we’ve seen a huge growth in open source contributions. The #open-source community has opened over 400 000 pull requests during October alone. That’s insane!I started looking into projects with large amounts of contributions. It got me thinking. A common pattern started appearing. They all have amazing readme.md files. I doubt it would have been easy to contribute otherwise. There may be a connection. I’d sure say there is!Let’s mention a few famous projects like React, Vue, freeCodeCamp, Sourcerer or Serverless. You can see their readme.md’s are a perfect blend of documentation, project overview, FAQ, and contribution steps. They mention the ecosystem, the community, and have visuals explaining the open source project itself.Because the open-source community (...)