4 ms·
I worked at a (non-tech) company that had internal org-wide code visibility + a strong culture of README always documenting "How do I run this?" It was a godse
by ethbr0 4y ago
I worked at a (non-tech) company that had internal org-wide code visibility + a strong culture of README always documenting "How do I run this?"
It was a godsend and game changer for quickly finding reusable code and understanding how it did what it did.
There were some key enablers (well-designed permissions request system, mature EDW), but at the end of the day it was people taking the time.
Since then I've always tried to be that person -- if someone who knows nothing about the project can't get it running on a reasonably standard system by following the steps in the README, then the README isn't finished.