From a88506d69570d2c4e1b4204873c9df22a1ca19e9 Mon Sep 17 00:00:00 2001 From: Zeke Sikelianos Date: Wed, 18 Jul 2018 07:56:31 -0700 Subject: [PATCH] add semantic-pull-requests to apps directory --- _apps/semantic-pull-requests.md | 47 +++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 _apps/semantic-pull-requests.md diff --git a/_apps/semantic-pull-requests.md b/_apps/semantic-pull-requests.md new file mode 100644 index 0000000..8092944 --- /dev/null +++ b/_apps/semantic-pull-requests.md @@ -0,0 +1,47 @@ +--- +title: Semantic Pull Requests +description: Status check that ensures your pull requests follow the Conventional Commits spec +slug: semantic-pull-requests +screenshots: + - https://user-images.githubusercontent.com/2289/42729629-110812b6-8793-11e8-8c35-188b0952fd66.png + - https://user-images.githubusercontent.com/2289/42729632-11980b32-8793-11e8-9f8d-bf16c707f542.png +authors: [zeke, bkeepers] +repository: probot/semantic-pull-requests +host: https://probot-semantic-pull-requests.herokuapp.com +--- + +> GitHub status check that ensures your pull requests follow the Conventional Commits spec + +Using [semantic-release](https://github.com/semantic-release/semantic-release) +and [conventional commit messages](https://conventionalcommits.org)? Install this +[Probot](https://probot.github.io/) app +on your repos to ensure your pull requests are semantic before you merge them. + +## How it works + +Take this PR for example. None of the commit messages are semantic, nor is the PR title, so the status remains yellow: + + +screen shot 2018-07-14 at 6 22 58 pm + +screen shot 2018-07-14 at 6 22 10 pm + +--- + +Edit the PR title by adding a semantic prefix like `fix: ` or `feat: ` or any other +[conventional commit type](https://github.com/commitizen/conventional-commit-types/blob/master/index.json). Now use `Squash and Merge` to squash the branch onto master and write a standardized commit message while doing so: + +--- + +screen shot 2018-07-14 at 6 23 11 pm + +screen shot 2018-07-14 at 6 23 23 pm + + +## Installation + +👉 [github.com/apps/semantic-pull-requests](https://github.com/apps/semantic-pull-requests) + +## License + +[Apache 2.0](LICENSE) \ No newline at end of file