Uploaded image for project: 'Core Server'
  1. Core Server
  2. SERVER-58378

check_todos.py does not provide actionable next steps

    XMLWordPrintableJSON

Details

    • Task
    • Status: Closed
    • Major - P3
    • Resolution: Done
    • None
    • None
    • None
    • None
    • DAG 2021-08-09
    • 1

    Description

      Here is the error message logged from check_todos.py failure:

      [2021/07/08 02:10:50.996] Checking for TODOs associated with Jira key in commit message.
      [2021/07/08 02:10:50.996] SERVER-51476
      [2021/07/08 02:10:50.996] ./etc/third_party_components.yml
      [2021/07/08 02:10:50.996] 	48: upgrade_suppression: TODO SERVER-51476
      [2021/07/08 02:10:50.996] Checking complete - todos found: True
      

      This message does not explain to developer why to a developer that finding a TODO is a bad idea or what action they should take to make check_todos.py succeed.

      Expected:
      Some descriptive text should accompany the failure. The text should state:
      1. Why TODOS are not permitted to remain in code that reference a jira ticket associated with the commit
      2. Explain what steps developers should take to fix the code.

      Attachments

        Activity

          People

            jeff.zambory@mongodb.com Jeffrey Zambory
            mark.benvenuto@mongodb.com Mark Benvenuto
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: