https://github.com/prosebot/prosebot

🤖🔊 Probot App to help you write better on GitHub.
https://github.com/prosebot/prosebot

checks-api ci english-grammar probot probot-app

Last synced: 4 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/prosebot/prosebot
• Owner: prosebot
• License: isc
• Created: 2018-10-22T20:35:33.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T18:06:25.000Z (about 2 years ago)
• Last Synced: 2024-09-27T08:02:24.571Z (4 months ago)
• Topics: checks-api, ci, english-grammar, probot, probot-app
• Language: JavaScript
• Homepage:
• Size: 1.99 MB
• Stars: 44
• Watchers: 2
• Forks: 7
• Open Issues: 26
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        


  



prosebot[bot]

Probot App to help you write better on GitHub.


 


## Usage

After [installing the GitHub App on your repos](https://github.com/apps/prosebot), 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](#credits). 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](https://github.com/btford/write-good#checks).

### Installation

Visit [the installation page](https://github.com/apps/prosebot) 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`:

```yaml

# .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`](https://github.com/btford/write-good)

- [`alex`](https://github.com/get-alex/alex)

- [`node-spellchecker`](https://github.com/atom/node-spellchecker)

- [`node-markdown-spellcheck`](https://github.com/lukeapage/node-markdown-spellcheck)

### Future work

- Using [Suggested Changes](https://blog.github.com/changelog/2018-10-16-suggested-changes/) to... suggest changes.

- Work on multiple PRs at a time

- Nicer annotations

- More providers? [Open an issue!](https://github.com/JasonEtco/prosebot/issues/new)