Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-9966

Recommend that TODO comments link to Jira

    XMLWordPrintable

    Details

      Description

      Following discussion on RFC-307, this ticket adds the following rule to the Python style guide:

      To-do comments SHOULD include a Jira issue key

      If the commented code is a workaround for a known issue, this rule makes it easier to find and remove the workaround once the issue has been resolved. If the commented code itself is the problem, this rule ensures the issue will be reported on Jira, making it more likely to be fixed in a timely manner.

      # TODO: DM-12345 is triggered by this line


      # TODO: workaround for DM-6789

      and the following rule to the C++ style guide:

      6-26. To-do comments SHOULD include a Jira issue key

      If the commented code is a workaround for a known issue, this rule makes it easier to find and remove the workaround once the issue has been resolved. If the commented code itself is the problem, this rule ensures the issue will be reported on Jira, making it more likely to be fixed in a timely manner.

      // TODO: DM-12345 is triggered by this line


      // TODO: workaround for DM-6789

        Attachments

          Issue Links

          is triggered by

          RFC - An issue whose primary purpose is to advertise an intent and allow stakeholders to comment. RFC-307 Discourage use of @todo Doxygen tag

          • Implemented

            Activity

            Ascending order - Click to sort in descending order
            No builds found.
            krzys Krzysztof Findeisen created issue -
            krzys Krzysztof Findeisen made changes -
            Field Original Value New Value
            Epic Link DM-9680 [ 30785 ]
            krzys Krzysztof Findeisen made changes -
            Link This issue is triggered by RFC-307 [ RFC-307 ]
            krzys Krzysztof Findeisen made changes -
            Description Following discussion on RFC-307, this ticket adds the following rule to the Python style guide:

            h3. To-do comments SHOULD include a Jira issue ID

            If the commented code is a workaround for a known issue, this rule makes it easier to find and remove the workaround once the issue has been resolved. If the commented code itself is the problem, this rule ensures the issue will be reported on Jira, making it more likely to be fixed in a timely manner.

            {code}
            # TODO: DM-12345 is triggered by this line
            {code}

            {code}
            # TODO: workaround for DM-6789
            {code}

            ----

            and the following rule to the C++ style guide:

            h4. 6-26. To-do comments SHOULD include a Jira issue ID

            If the commented code is a workaround for a known issue, this rule makes it easier to find and remove the workaround once the issue has been resolved. If the commented code itself is the problem, this rule ensures the issue will be reported on Jira, making it more likely to be fixed in a timely manner.

            {code}
            // TODO: DM-12345 is triggered by this line
            {code}

            {code}
            // TODO: workaround for DM-6789
            {code}             		Following discussion on RFC-307, this ticket adds the following rule to the Python style guide:

            h3. To-do comments SHOULD include a Jira issue key

            If the commented code is a workaround for a known issue, this rule makes it easier to find and remove the workaround once the issue has been resolved. If the commented code itself is the problem, this rule ensures the issue will be reported on Jira, making it more likely to be fixed in a timely manner.

            {code}
            # TODO: DM-12345 is triggered by this line
            {code}

            {code}
            # TODO: workaround for DM-6789
            {code}

            ----

            and the following rule to the C++ style guide:

            h4. 6-26. To-do comments SHOULD include a Jira issue key

            If the commented code is a workaround for a known issue, this rule makes it easier to find and remove the workaround once the issue has been resolved. If the commented code itself is the problem, this rule ensures the issue will be reported on Jira, making it more likely to be fixed in a timely manner.

            {code}
            // TODO: DM-12345 is triggered by this line
            {code}

            {code}
            // TODO: workaround for DM-6789
            {code}
            krzys Krzysztof Findeisen made changes -
            Rank Ranked higher
            krzys Krzysztof Findeisen made changes -
            Sprint Alert Production S17 - 4 [ 610 ]
            krzys Krzysztof Findeisen made changes -
            Rank Ranked higher
            krzys Krzysztof Findeisen made changes -
            Status To Do [ 10001 ] In Progress [ 3 ]
            Hide
            Permalink
            krzys Krzysztof Findeisen added a comment -

            Hi Kian-Tat Lim, could you please review DM-7892 and DM-9966? These are the final changes to the dev guide needed to close RFC-225 and RFC-307, and they're fairly small updates.

            Show
            krzys Krzysztof Findeisen added a comment - Hi Kian-Tat Lim , could you please review DM-7892 and DM-9966 ? These are the final changes to the dev guide needed to close RFC-225 and RFC-307 , and they're fairly small updates.
            krzys Krzysztof Findeisen made changes -
            Reviewers Kian-Tat Lim [ ktl ]
            Status In Progress [ 3 ] In Review [ 10004 ]
            Hide
            Permalink
            ktl Kian-Tat Lim added a comment -

            LGTM. Ship it!

            Show
            ktl Kian-Tat Lim added a comment - LGTM. Ship it!
            ktl Kian-Tat Lim made changes -
            Status In Review [ 10004 ] Reviewed [ 10101 ]
            krzys Krzysztof Findeisen made changes -
            Sprint Alert Production S17 - 4 [ 610 ] Alert Production S17 - 3 [ 605 ]
            krzys Krzysztof Findeisen made changes -
            Resolution Done [ 10000 ]
            Status Reviewed [ 10101 ] Done [ 10002 ]

              People

              Assignee:
              krzys Krzysztof Findeisen
              Reporter:
              krzys Krzysztof Findeisen
              Reviewers:
              Kian-Tat Lim
              Watchers:
              Jim Bosch, Jonathan Sick, Kian-Tat Lim, Krzysztof Findeisen
              Votes:
              0 Vote for this issue
              Watchers:
              4 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.