pwablito / gh_spellcheck

Bot for spellchecking GitHub repositories

GitHub Spellcheck Bot

Downloads GitHub repositories, checks for spelling errors, and makes a fork and pull request to fix them.

gh_spellcheck's Issues

Balancing

Implement a balanced thread to maintain relatively equal numbers of different task types at a time.

Separate `StatusQueueController` and `TaskQueueController` and provide each the same semaphore in `master_proc`

Parallel queue threads

To allow for scaling, implement a way for multiple queue instances to run simultaneously.

Multinode parallelism

Implement a solution for running across multiple nodes and processes for increased scalability

Handle shutdown

When the program is shut down, the queue should be dumped to disk. An option should be provided at startup to resume from a saved state.

Verbosity Control

Implement a -v, -vv, -vvv, etc option to adjust the verbosity of logging

Spellcheck validation

Find a way to validate spellings with a human before creating pull requests. One idea would be to simply email a list of pull requests to someone after creating them just so they can go look at them and change them from drafts to open requests.

Recursive scraping

Fetch more handles recursively and add them to the queue as scrape tasks

Improve spellcheck algorithm

The repo currently uses TextBlob for spellchecking. This should be replaced with something more versatile and more conservative to prevent pushing incorrect spelling changes.

Logging

Implement logging for threads and queues.

Scrape Organizations

Should be able to scrape repositories from organizations just like users. Perhaps organizations could either be provided via command line or could be obtained using any orgs that a user is a public member of or has contributed to recently.