Why you should have an ARCHITECTURE.md ↦
If you maintain an open-source project in the range of 10k-200k lines of code, I strongly encourage you to add an ARCHITECTURE document next to README and CONTRIBUTING. Before going into the details of why and how, I want to emphasize that this is not another “docs are good, write more docs” advice. I am pretty sloppy about documentation, and, eg, I often use just “simplify” as a commit message. Nonetheless, I feel strongly about the issue, even to the point of pestering you:-)
The author points to rust-analyzer as a good example.
Sign in or Join to comment or subscribe
Great article. I am now compelled to refresh all of my popular repos and update them :D!
Jerod co-hosts The Changelog, crashes JS Party, and takes out the trash (his old code) once in awhile.
And I am compelled to keep all of my projects < 10k LOC so I don’t have to write this! 🤣