Search
⌘K
    to navigateEnterto select Escto close

    FIXME and TODO

    As developers, we know that it is extremely hard to come to work on a TODO or FIXME. However, there are circumstances where we do not have the required time to take care of things properly; hence the need for FIXME or TODO.

    We believe a FIXME or a TODO without a GitHub issue has no meaning.

    So, instead of having an old-fashioned comment like this:

    1# FIXME: When user changes auto-reply from "on" to "off"
    2# then system will resend the request. It should not.

    We prefer that developers create a GitHub issue and assign that issue to himself/herself. So now the comment would look like this:

    1# FIXME: When user changes auto-reply from "on" to "off" then system
    2#        will resend the request. It should not.
    3#        Issue: https://github.com/bigbinary/wheel/issues/1

    The bottom line is that a FIXME or a TODO without a GitHub issue is meaningless.

    Previous
    Next