CodingWithJamal
CodingWithJamal•11mo ago

for the last 10mins ive been reading

for the last 10mins ive been reading some of the convex source code, its massive and clean props to all the hard workers on this project! Also surprised at the almost total lack of code comments in the code base.
5 Replies
Michal Srb
Michal Srb•11mo ago
Clean code doesn't need comments (mostly 😎)
nipunn
nipunn•11mo ago
hehe sometimes no comment is better than out-of-date-comment. Code never lies.
Indy
Indy•11mo ago
I had a professor in college who disliked comments. He was all about just reading code.
CodingWithJamal
CodingWithJamalOP•11mo ago
i agree, if your code can speak for itself then thats better. does convex team have there own internal docs for core members? because code bases with 200k+ lines for new developers could be confusing to fully understand no? Especially if they’re just joining the project.
nipunn
nipunn•11mo ago
We have a little bit in the way of docs (we use Notion), but usually we give in-person talks at the whiteboard to new core members to get up to speed. With things in flux so fast, it almost behooves us to wait before really investing in detailed internal docs. Surely we'll have to add more over time, and we'll definitely try to share out whatever makes sense to do.

Did you find this page helpful?