Skip to content

An inclusive language GitHub App for detecting and suggesting changes to insensitive language in pull requests.

License

Notifications You must be signed in to change notification settings

jpoehnelt/in-solidarity-bot

Repository files navigation

In Solidarity

Install Build Release codecov GitHub contributors semantic-release npm

A GitHub Bot built with Probot that checks for inclusive language. See our documentation for more information.

Install

The app can be installed at https://github.com/apps/in-solidarity.

Note: The checks currently run on public repositories. This helps limit permissions for organizations with many repositories.

Share this app with one of the following badges.

[![](https://github.com/jpoehnelt/in-solidarity-bot/raw/main/static//badge-flat.png)](https://github.com/apps/in-solidarity)

[![](https://github.com/jpoehnelt/in-solidarity-bot/raw/main/static//badge-flat-square.png)](https://github.com/apps/in-solidarity)

[![](https://github.com/jpoehnelt/in-solidarity-bot/raw/main/static//badge-for-the-badge.png)](https://github.com/apps/in-solidarity)

Documentation

Rules and configuration options are at ./docs/README.md.

Production

A hosted version of this app is available and a basic status page can be found at https://stats.uptimerobot.com/rX0A4iA75m.

Development

# Install dependencies
npm install

# Run typescript
npm run build

# Test
npm test  # npm test -- -u to update snapshots
npm run lint  # npm run format to fix issues

# Set appropriate .env values and run the bot
npm start

Contributing

Note: Additional rules are welcome and can be added in src/rules.ts.

If you have suggestions for how the bot could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

This is not an official Google product.