ARCHITECTURE.md

ARCHITECTURE.md Feb 6, 2021 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 “si

[kfujieda]

自分が保守しているOSSのコードが1万行を超えてきたら、READMEとCONTRIBUTINGに続いてARCHITECTUREを書くといいよ。

[kent4989]

末尾にドキュメントの良い例も示されており、参考になる。

[nekoruri]

ARCHITECTURE.md なるほど

[mojimojikun]

なるほど ARCHITECTURE.md

[braitom]

10k-200kくらいのコード量のOpen Sourceプロジェクトをメンテするときは高レベルのアーキテクチャを説明したARCHITECTURE.mdを書くと良いよという話。

[daikikohara]

ほー、そんな文化ができたのか。ググると結構出てくるな。参考にしよう。