https://github.com/uber-workflow/probot-app-pr-title
Enforces the format of PR titles/commits
https://github.com/uber-workflow/probot-app-pr-title
probot-app
Last synced: 3 months ago
JSON representation
Enforces the format of PR titles/commits
- Host: GitHub
- URL: https://github.com/uber-workflow/probot-app-pr-title
- Owner: uber-workflow
- License: mit
- Created: 2017-10-09T22:18:01.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-12-16T02:00:38.000Z (almost 2 years ago)
- Last Synced: 2025-06-20T10:49:09.753Z (4 months ago)
- Topics: probot-app
- Language: JavaScript
- Homepage:
- Size: 195 KB
- Stars: 7
- Watchers: 3
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# probot-app-pr-title
[![build status][build-badge]][build-href]
[![dependencies status][deps-badge]][deps-href]
[![npm version][npm-badge]][npm-href]
> a GitHub App built with [probot](https://github.com/probot/probot) that enforces the format of PR titles/commits
## Overview
The purpose of this bot is to reject PRs with titles that do not conform to format described in https://chris.beams.io/posts/git-commit/
In summary, a PR should be titled such that the sentence "If applied, this commit will $PR_TITLE" makes sense.
## Setup
```
# Install dependencies
npm install
# Run the bot
npm start
```
See [docs/deploy.md](docs/deploy.md) if you would like to run your own instance of this app.
[build-badge]: https://badge.buildkite.com/dafda46de3acff0f75fbf6f4111d8c0cf885700b3c0ef6c6ba.svg?branch=master
[build-href]: https://buildkite.com/uberopensource/probot-app-pr-title
[deps-badge]: https://david-dm.org/uber-web/probot-app-pr-title.svg
[deps-href]: https://david-dm.org/uber-web/probot-app-pr-title
[npm-badge]: https://badge.fury.io/js/probot-app-pr-title.svg
[npm-href]: https://www.npmjs.com/package/probot-app-pr-title