Skip to main content

You are not logged in. Your edit will be placed in a queue until it is peer reviewed.

We welcome edits that make the post easier to understand and more valuable for readers. Because community members review edits, please try to make the post substantially better than how you found it, for example, by fixing grammar or adding additional resources and hyperlinks.

Required fields*

6
  • 7
    Don't document what software someone needs to to the build (or at least don't just document): make the build script tell the user what he's missing or even install it itself if that's reasonable. In most of my repos any half-way competent developer can just run ./Test and get a build or get good information about what he needs to do to get a build. Commented May 13, 2019 at 15:14
  • 5
    I don't really agree that putting generated documentation into git can be good in the case you specify. That's the reason we have artifactories and archives. Commented May 13, 2019 at 17:13
  • That is your rule and it is a good rule and I like it. But others can make their own rules. Commented May 13, 2019 at 20:41
  • I think you mean "run a build command," as there would be no build button on your machine. ...Unless you're expecting the entire build to be integrated with an IDE, which is wholly unreasonable. Commented May 14, 2019 at 15:14
  • @jpmc26 I find it totally reasonable to have the entire build integrated in an IDE. The build button on my machine is Command-B. Commented May 15, 2019 at 21:35