[SERVER-58378] check_todos.py does not provide actionable next steps Created: 08/Jul/21  Updated: 04/Aug/21  Resolved: 04/Aug/21

Status: Closed
Project: Core Server
Component/s: None
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Major - P3
Reporter: Mark Benvenuto Assignee: Jeffrey Zambory
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Sprint: DAG 2021-08-09
Participants:
Story Points: 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.



 Comments   
Comment by Githook User [ 04/Aug/21 ]

Author:

{'name': 'Jeff Zambory', 'email': 'jeff.zambory@mongodb.com'}

Message: SERVER-58378: check_todos.py does not provide actionable next steps
Branch: master
https://github.com/mongodb/mongo/commit/15c7dad62ef5f54e29cc1a43d44c81f631c302f0

Generated at Thu Feb 08 05:44:21 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.