Semantic PR Title

A GitHub App built with Probot that enforces your PR title to match a user defined regex.

Config

Add a file @ .github/semantic-pr-title.yml with the following:

REGEX: <your regex here>

The default regex enforces the angular commit convention (first line) on your PR title: (build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\\([a-z0-9\\s]+\\))?(:\\s)([a-z0-9\\s]+)

Note that the regex is a string and \ must be escaped.

Setup

# Install dependencies
npm ci

# Run the bot
npm run dev

Usage

This app is hosted on Glitch and available on the GitHub marketplace.

Contributing

If you have suggestions for how pr-title-linter 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.

License

ISC © 2019 Cole Hafner (https://colehafner.com)