Skip to content
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

docs: cleanup todo comments #1231

Merged
merged 1 commit into from
Aug 10, 2022
Merged

docs: cleanup todo comments #1231

merged 1 commit into from
Aug 10, 2022

Conversation

robert-zaremba
Copy link
Member

Description

closes: #1197


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • added appropriate labels to the PR
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@robert-zaremba robert-zaremba requested a review from a team as a code owner August 10, 2022 11:37
@codecov-commenter
Copy link

Codecov Report

Merging #1231 (3a76f1c) into main (43c0441) will increase coverage by 0.00%.
The diff coverage is 0.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1231   +/-   ##
=======================================
  Coverage   51.20%   51.20%           
=======================================
  Files          67       67           
  Lines        6659     6657    -2     
=======================================
- Hits         3410     3409    -1     
+ Misses       3009     3008    -1     
  Partials      240      240           
Impacted Files Coverage Δ
x/leverage/keeper/interest.go 72.29% <0.00%> (+0.29%) ⬆️
x/leverage/module.go 57.14% <ø> (ø)

@RafilxTenfen
Copy link
Contributor

The Halborn audit suggested removing the TODO's from the code
I can't entirely agree with them, but I created the issue for us to discuss
If all the team decide to keep using TODO's in the middle of the code we should approve this

@adamewozniak
Copy link
Collaborator

The Halborn audit suggested removing the TODO's from the code I can't entirely agree with them, but I created the issue for us to discuss If all the team decide to keep using TODO's in the middle of the code we should approve this

Kind of silly to not allow todos in a codebase imo, especially since the todos we have don't really point to areas of confusion / possible vulnerabilities.

If these said "TODO: make this more secure", maybe I'd agree

@mergify mergify bot merged commit 959a1e4 into main Aug 10, 2022
@mergify mergify bot deleted the robert/hal-09 branch August 10, 2022 14:57
@adamewozniak adamewozniak mentioned this pull request Aug 10, 2022
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Leverage: (HAL-09) OPEN TODOs
4 participants