-
Notifications
You must be signed in to change notification settings - Fork 328
CHANGE: Removing TODOs and moving them to jira tasks #2316
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
🤖 Helpful? Please react with 👍/👎 | Questions❓Please reach out in Slack #ask-u-pr-agent |
PR Code Suggestions ✨No code suggestions found for the PR. |
|
Although this ticket cleans up code I agree with AI review that it removes/reduces ability to track/trace these issues down going forward. I would strongly suggest that at least each TODO, REVIEW etc provides traceability back to its origin. Just looking at the tickets without the code contexts makes it very difficult to decipher IMO. Hence, would it be possible to link each removed entry back to the exact line where it was removed for reference (from the JIRA ticket), and maybe also link back to this PR (the PR removing it) to make it easier to review the removal in context? What do you think? I also believe there is merit to the AI review on documentation gap where it may either be handled as being defined as part of the filed JIRA ticket as documentation debt or addressed directly on this PR. E.g. removing something like "TODO: Make this method thread-safe" could be argued it should result in documentation of such method to explicitly state the method is not thread-safe unless the Unity documentation convention is that methods are by default not thread-safe and only thread-safe if explicitly stated. I am not aware whether such a convention exists but its a fair point IMO. |
|
The request changes maps to the traceability aspect of linked tickets and not to the code itself. |
Done, added 2 links in each Jira ticket to ensure each removed todo can be traced back to its original source and intent. |
ekcoh
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for providing the requested traceability. I think it's beneficial down the road. IMO this can land now. Adding QA in case there is some "process feedback" here. I also wonder how to best track these since they are a mix of issues, feature requests and discussion points. Maybe they should sit in an epic of "technical debt", moving them to tickets only "hides the real issues".
|
Just my opinion warning😅: I don't really see a real benefit and to me it just seems like hiding things under the carpet. Wouldn't it be more likely to be implemented if someone is working on the area -> sees a todo -> thinks about it as it is within their context and or implements it right away. As opposed to: works on the area -> a ticket about the todo exists in some epic that nobody reads -> maybe in a blue moon we work on that epic. But I'm absolutely not blocking it if you feel like It's better this way |
Pauliusd01
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is allowed to go in now as it wouldn't need retesting the new release
|
I will create an EPIC JIRA so we can have some guarantees that they don't get forgotten forever. |
|
I don't think these should be removed from code if they are not being fixed. Having them in JIRA tickets it's not a better system because developers will not browse JIRA if they need context on a particular issue a class. |
Description
Removing TODOs and moving them to jira tasks:
Removing TODO: InputSystem.csRemoving TODO: InputSettings.csRemoving TODO: InputManager.csRemoving TODO: InputStateHistory.csRemoving TODO: InputStateBlock.csRemoving TODO: SteamIGAConverter.csRemoving TODO: Touchscreen.csRemoving TODO: Pointer.csRemoving TODO: InputControlLayout.csRemoving TODO: InputControl.csRemoving TODO: InputBindingComposite.csRemoving TODO: InputActionTrace.csTesting status & QA
n/a
Overall Product Risks
Please rate the potential complexity and halo effect from low to high for the reviewers. Note down potential risks to specific Editor branches if any.
Comments to reviewers
Please describe any additional information such as what to focus on, or historical info for the reviewers.
Checklist
Before review:
Changed,Fixed,Addedsections.Area_CanDoX,Area_CanDoX_EvenIfYIsTheCase,Area_WhenIDoX_AndYHappens_ThisIsTheResult.During merge:
NEW: ___.FIX: ___.DOCS: ___.CHANGE: ___.RELEASE: 1.1.0-preview.3.