search

OpenEnergyDashboard / OED

Open Energy Dashboard (OED)
Mozilla Public License 2.0
82 stars 307 forks source link

figure out TODO items in code #592

Open huss opened 3 years ago

huss commented 3 years ago

The OED code base has TODO comments. We need to find them all, see if they are important, see if issues exist as appropriate or they need to be created.

Mushmou commented 1 year ago

Hello Team L from CTI would like to work on this issue.

Mushmou commented 1 year ago

@huss Our team developed a plan to capture all TODO comments onto a google doc and were going to determine if the TODO comments need to be turned into an issue.

huss commented 1 year ago

Ok. Thank you for taking this on. I'm sure there is quite a range of them so any progress would be good. The project can also help with making issues if that would help.

huss commented 1 year ago

Thanks to @Mushmou and their team for doing this so quickly. If you can give the link to the Google Doc in the issue then the project can put it in any needed format and remix with other documents for getting the work done.

huss commented 1 year ago

I realized I don't have a record of the list. Is it possible to get the list and/or a link? Thanks.

huss commented 7 months ago

Noting that this issue is still open and not real progress has been made.

MattMiss commented 2 weeks ago

My team would like to take on this issue if possible. Other members include @vladoleksiyenko @Gene7Him and @brandonviorato

We can continue with the same plan of creating a google doc to list each of the TODO's and any other helpful info if one hasn't been created yet.

huss commented 2 weeks ago

My team would like to take on this issue if possible. Other members include @vladoleksiyenko @Gene7Him and @brandonviorato

We can continue with the same plan of creating a google doc to list each of the TODO's and any other helpful info if one hasn't been created yet.

Sounds good. Let me know if I can help.

MattMiss commented 1 week ago

@huss We've found/documented most of the 160 TODO comments in the codebase, noting whether each one needs an issue, has an issue, or is related to an existing issue. Before we finish, I’d appreciate any feedback you have to ensure we're on the right track.

Also, when everything is looking good, would you prefer we keep and share this as a Google Doc, or would you rather us convert it to an MD file than can be added to the project and accessed by anyone?

TODO Comments google doc

huss commented 1 week ago

First, thanks to @MattMiss, @vladoleksiyenko @Gene7Him & @brandonviorato for doing this. Overall, the document looks great and this is a big help.

@huss We've found/documented most of the 160 TODO comments in the codebase, noting whether each one needs an issue, has an issue, or is related to an existing issue. Before we finish, I’d appreciate any feedback you have to ensure we're on the right track.

It seems great to me and I don't have any suggestions.

Also, when everything is looking good, would you prefer we keep and share this as a Google Doc, or would you rather us convert it to an MD file than can be added to the project and accessed by anyone?

I think creating a new design doc for the open TODO items would be great. You can clone that repo, make the needed changes and then put in a pull request for the changes. I could do it but I think it might be best for the team so it is publicly under your GitHub IDs since you did the work.

On mechanics: Do you have an automated tool to convert a Google Doc to markdown? I have a Google Doc extension that does a decent job, in most cases, of giving a good first shot that can then be cleaned up. Let me know if you want info or have me give it the first shot.

Please let me know if I can help in any way and many thanks. Once this is done, I think the issue will be ready to close.

MattMiss commented 4 days ago

Thank you for your input and tip on the google doc extension. I converted our document into a markdown file and formatted it a bit, then made a Pull Request with the new markdown file here: https://github.com/OpenEnergyDashboard/DesignDocs/pull/4.

Feel free to make any changes or let me know if there is anything else you would like done with this.