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

[Tooling] Implement a TODO method for the logging module #478

Closed
7 tasks
Gustavobelfort opened this issue Jan 31, 2023 · 1 comment
Closed
7 tasks

[Tooling] Implement a TODO method for the logging module #478

Gustavobelfort opened this issue Jan 31, 2023 · 1 comment
Labels
code health Nice to have code improvement community Open to or owned by a non-core team member core starter task Good for newcomers, but aimed at core team members though still open for everyone tooling tooling to support development, testing et al

Comments

@Gustavobelfort
Copy link
Contributor

Gustavobelfort commented Jan 31, 2023

Objective

Add a TODO method to the logging module to improve our workflow.

This method would allow us to add a log message with a TODO tag, indicating that a task is not yet completed. The method would allow us to identify these tasks and prioritize them quickly.

Example Usage:

u.logger.TODO().Msg("Log message explaining the TODO")

Origin Document

Screenshot 2023-01-30 at 6 59 45 PM

Goals

  • Increase ease of adding and visibility of finding TODOs in our logs
  • The TODO messages should be clearly distinguishable from other log messages

Deliverable

  • TODO Method extending the zerolog api added to the logging module
  • Updated documentation on how to use this
  • Updating all printed TODOs in the code (not the comments) with this the new function

Non-goals / Non-deliverables

  • Updating all the TODOs in the comments with a log message
  • Adding new logs

General issue deliverables

  • Update the appropriate CHANGELOG(s)
  • Update any relevant local/global README(s)

Testing Methodology

  • All tests: make test_all
  • LocalNet: verify a LocalNet is still functioning correctly by following the instructions at docs/development/README.md

Creator: @Gustavobelfort
Co-Owners: @Olshansk

@Gustavobelfort Gustavobelfort added the tooling tooling to support development, testing et al label Jan 31, 2023
@Olshansk Olshansk added code health Nice to have code improvement core starter task Good for newcomers, but aimed at core team members though still open for everyone labels Jan 31, 2023
@Olshansk Olshansk added the community Open to or owned by a non-core team member label Mar 10, 2023
@Olshansk
Copy link
Member

Closing this out as unplanned for the foreseeable future. Ticket can be reopened if/when needed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health Nice to have code improvement community Open to or owned by a non-core team member core starter task Good for newcomers, but aimed at core team members though still open for everyone tooling tooling to support development, testing et al
Projects
Status: Done
Development

No branches or pull requests

2 participants