• DontTakeMySky
    link
    111 months ago

    Code comments for "why"s that persist. Commits for why’s that are temporary.

    If you need to run X before Y, add a comment. If you added X before why because it was easier, leave it in a commit

      • DontTakeMySky
        link
        211 months ago

        With a comment on the test detailing why it matters so people don’t just assume the test is out of date when it fails.

        And ideally test the underlying result of x before y, not the fact that x is called before y.

        And while we’re at it, assert in Y that X has been called, and again comment the reason for the preconditions.