ARCHITECTURE.md

matklad.github.io · 634 words · saved by 1 readers

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, e.g., I often use just simplify as a commit message. Nonetheless, I feel strongly about the issue, even to the point of pestering you :-)

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, e.g., I often use just “simplify” as a commit message. Nonetheless, I feel strongly about the issue, even to the point of pestering you :-) I have experience with both contributing to and maintaining open-source projects. One of the lessons I’ve learned

ARCHITECTURE.md

related reading