Skip to content
πŸ€–πŸ”Š Probot App to help you write better on GitHub.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
test
.env.example
.gitignore
.travis.yml
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md
app.yml
codecov.yml
index.js
package-lock.json
package.json

README.md

prosebot[bot]

Probot App to help you write better on GitHub.

Build Status Codecov

Usage

After installing the GitHub App on your repos, this Probot App listens for changes to Markdown files (.md) or text files (.txt) 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:

image

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:

Future work

You can’t perform that action at this time.