prosebot / prosebot

🤖🔊 Probot App to help you write better on GitHub.

prosebot[bot]

Probot App to help you write better on GitHub.

Usage

After installing the GitHub App on your repos, this Probot App listens for changes to Markdown files (.md) or text files (.txt) in pull requests and runs various checks against them to provide feedback on the English. Currently, the app checks for spelling, prose and inclusive verbiage. This is done by leveraging existing open source libraries, which you can find listed below. Here's how it looks in action:

What it checks

A non-exhaustive list of the various checks that are run:

• Correct spelling (and provides possible corrections).
• Use of non-inclusive/profane/offensive language.
• Various prose-related checks, find the full list here.

Installation

Visit the installation page and install the GitHub App on your repositories. That's all there is to it ❤️

Configuration

There are currently three providers that the app uses to test your text. These can each be disabled, and are all enabled by default. To disable a provider, add a .github/prosebot.yml file to your repository and set the provider to false:

# .github/prosebot.yml
writeGood: true
alex: true
spellchecker: true

Credits

This Probot App is mostly a wrapper around existing open source libraries. The majority of the work is done by those, and they deserve a ton of thanks:

• write-good
• alex
• node-spellchecker
• node-markdown-spellcheck

Future work

• Using Suggested Changes to... suggest changes.
• Work on multiple PRs at a time
• Nicer annotations
• More providers? Open an issue!

prosebot's Issues

Could there be a dictionary defined for the repo??

I get a lot of false-positives on my CS-related hugo site. I love this bot though I wish that maybe that could be a thing.

Add support for HTML

Hello @JasonEtco!

We'd love to use Prosebot but most of our text is in HTML files. Would you be open to adding support for HTML in addition to .md and .txt?

I'd be happy to make the PR.

Make the README more clear about how prosebot polls for changes

Please could the README be more explicit about how the bot works? I haven't been able to have it work on my repo: https://github.com/jasikpark/jasik-xyz/

Config file in readme vs app page discrepancy

I see a config file named .github/prosebot.yml in this GitHub repo readme, but the app says .github/write-good.yml, which is correct?

Facing issue with prosebot

I have installed it in my git, but some how app is not working. I have created yml file in .github directory. am I missing something here. Any prerequisites required here ?

Misspelled works not working?

I just received the following warning:

"behavior" is misspelled. How about: behaviors, behavior, behave, behooving

It has the word in the list of options correct spellings so it looks like a bug (although I could be wrong - my British and US spelling at constantly getting mixed together)

Example PR: https://github.com/gauntface/gauntface.com/pull/21/checks?check_run_id=51636047