4 ms·

Choose good names Keep functions small Organize the code so it is easy to read Write good tests, they serve as documentation Write a Readme file to explain

by tmaly 6y ago

Choose good names Keep functions small Organize the code so it is easy to read Write good tests, they serve as documentation Write a Readme file to explain the overall purpose of the code and anything not yet implemented in the code

sethammons 6y ago
A big plus one on a good readme. So many projects lack this. At work, my team’s readme for each project has the super high level purpose; the basic flow and entry points; steps for building and testing; links to design docs, build pipelines, metric dashboards, runbooks; etc.