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

Summarize all @TODOs in the codebase #543

Open
mihow opened this issue Aug 24, 2024 · 0 comments · May be fixed by #581
Open

Summarize all @TODOs in the codebase #543

mihow opened this issue Aug 24, 2024 · 0 comments · May be fixed by #581
Assignees
Labels
good first issue Good for newcomers

Comments

@mihow
Copy link
Collaborator

mihow commented Aug 24, 2024

  • Search the codebase for all comments with the "@todo" tag.
  • Create an index of all todos and which file, function & line number they appear in.
  • Categorize them
  • Group the ones that appear to refer to the same todo
  • Add an estimate for the size / effort of each todo

This seems like a good job for an LLM.

  • Try using repo2txt to compile & summarize the backend codebase in one file
  • Use Claude.ai (or Gemini 1.5 Pro if z longer context window is needed) to query the codebase and extract and summarize the todos as described above
  • Or write a script to extract the todos & some of their context, then use the LLMs just for the summarization steps
@mihow mihow added good first issue Good for newcomers vvv and removed vvv labels Aug 24, 2024
@vanessavmac vanessavmac self-assigned this Sep 3, 2024
@vanessavmac vanessavmac linked a pull request Sep 17, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants