https://github.com/jpoehnelt/in-solidarity-bot

An inclusive language GitHub App for detecting and suggesting changes to insensitive language in pull requests.
https://github.com/jpoehnelt/in-solidarity-bot

blacklivesmatter everyone github-bot hactoberfest inclusive inclusive-language language probot probot-app

Last synced: 7 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/jpoehnelt/in-solidarity-bot
• Owner: jpoehnelt
• License: apache-2.0
• Created: 2020-08-05T22:07:08.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2023-12-25T16:37:43.000Z (9 months ago)
• Last Synced: 2024-09-22T13:02:10.534Z (11 days ago)
• Topics: blacklivesmatter, everyone, github-bot, hactoberfest, inclusive, inclusive-language, language, probot, probot-app
• Language: TypeScript
• Homepage: https://github.com/jpoehnelt/in-solidarity-bot
• Size: 1.57 MB
• Stars: 43
• Watchers: 3
• Forks: 16
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# In Solidarity

[![Install](https://img.shields.io/badge/-Install%20App-blue)](https://github.com/apps/in-solidarity)

![Build](https://github.com/jpoehnelt/in-solidarity-bot/workflows/Build/badge.svg)

![Release](https://github.com/jpoehnelt/in-solidarity-bot/workflows/Release/badge.svg)

[![codecov](https://codecov.io/gh/jpoehnelt/in-solidarity-bot/branch/main/graph/badge.svg)](https://codecov.io/gh/jpoehnelt/in-solidarity-bot)

![GitHub contributors](https://img.shields.io/github/contributors/jpoehnelt/in-solidarity-bot?color=green)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![npm](https://img.shields.io/npm/v/in-solidarity-bot)](https://www.npmjs.com/package/in-solidarity-bot)

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

> A GitHub Bot built with [Probot](https://github.com/probot/probot) that checks for inclusive language. See [our documentation](./docs/README.md) for more information.

![](./static/screenshot.png)

## 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.

```md

[![](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)

```

[![](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](https://github.com/jpoehnelt/in-solidarity-bot/blob/main/docs/README.md).

## Production

A [hosted version of this app](https://github.com/apps/in-solidarity) is available and a basic status page can be found at https://stats.uptimerobot.com/rX0A4iA75m.

## Development

```sh

# 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](https://github.com/jpoehnelt/in-solidarity-bot/blob/main/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](CONTRIBUTING.md).

This is not an official Google product.