Add an index for all the files in the repo

michaelansel / CoreContributorBot

Use an LLM to maintain a code repository, acting as a core contributor to the codebase

0 stars 0 forks source link

Add an index for all the files in the repo #30

Open michaelansel opened 2 hours ago

michaelansel commented 2 hours ago

Three parts to this issue:

Update every Python file with one or more comments that describe what the file does (exclude non-Python files since they don't necessarily support in-line comments)
Add an INDEX.md file which lists every file in the repo and a short, one-line summary of what it contains
Update the style guide to direct everyone to maintain the first two descriptions as the files are changed

Note that we want the index to have descriptions of every file in the repository since this will be a search index for finding files when you have questions in the future. Exclude nothing.

michaelansel commented 2 hours ago

Bot Response: Handling in PR: https://github.com/michaelansel/CoreContributorBot/pull/31

michaelansel commented 2 hours ago

Only some files were covered in the PR; finish addressing all the files

michaelansel commented 2 hours ago

Bot Response: Handling in PR: https://github.com/michaelansel/CoreContributorBot/pull/36

michaelansel commented 1 hour ago

Update some more files that are lacking a summary comment or inclusion in the index

michaelansel commented 1 hour ago

Bot Response: Handling in PR: https://github.com/michaelansel/CoreContributorBot/pull/37

michaelansel commented 57 minutes ago

Look for any more Python files that are missing summary comments and update those files with summary comments.

michaelansel commented 38 minutes ago

Bot Response: Handling in PR: https://github.com/michaelansel/CoreContributorBot/pull/39