Code review comment for ~mpontillo/uvtool:dev-env-setup-and-hacking-instructions

Revision history for this message
Robie Basak (racb) wrote :

I appreciate and agree with having a HACKING.md. But rather than having a bunch of extra infrastructure, can we not just say, in HACKING.md:

Debian/Ubuntu build/runtime dependencies: <package1> <package2> ...

To run from the working tree, from the top level use: PYTHONPATH=. bin/uvt-kvm ...

Is there anything else required? By the time a new contributor has read HACKING.md and learned to run the "make install-dependencies" command, he/she might as well have learnt to just run "apt install ..." directly and be ready. The same goes for learning about the contrib/develop script.

I'm skeptical about a bunch of infrastructure that I feel is unnecessary. Contributors would end up having to learn what we have set up, and we would have to maintain it. Further, I expect there to be convention on this sort of thing and for us to follow it.

I think less is more here. I certainly get put off when arriving at a new project and finding a non-trivial development setup, such as custom non-standard code to run just to get things going.

« Back to merge proposal