Have you ever tried to get a good understanding of a project but found it was completely lacking any sort of meaningful documentation?
To speed up the process of new developer onboarding (And refreshing myself on how past projects work) I set out to create a comprehensive readme written in markdown. Below is the current iteration I use on all my new projects to highlight how code should be written, what tooling is used to get set up, and how to deploy.
Of course a lot of these things won't apply to every project which I why I haven't numbered the sections, so chop and change as needed.
What do you include in your readme?
This is just a high level view of what could be added to a readme to help new people to your project. Feel free to let me know what you include in yours via Twitter @graphicscove
Want to talk about this post? Discuss it with me on Twitter @graphicscove