kylefang/probot.github.io
1
0
Fork 0
mirror of https://github.com/zhigang1992/probot.github.io.git synced 2026-01-12 22:49:53 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #219 from probot/add-semantic-pull-requests-to-apps-directory

Browse Source 
add semantic-pull-requests to apps directory
This commit is contained in:
Bex Warner
2018-07-24 14:48:38 -07:00
committed by GitHub
parent 200526b519 66098a658c
commit 319ad48b72
1 changed files with 42 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
_apps/semantic-pull-requests.md Normal file
View File

@@ -0,0 +1,42 @@
---
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
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:
<img width="580" alt="screen shot 2018-07-14 at 6 22 58 pm" src="https://user-images.githubusercontent.com/2289/42729630-11370698-8793-11e8-922c-db2308e0e98e.png">
<img width="791" alt="screen shot 2018-07-14 at 6 22 10 pm" src="https://user-images.githubusercontent.com/2289/42729629-110812b6-8793-11e8-8c35-188b0952fd66.png">
---
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:
---
<img width="613" alt="screen shot 2018-07-14 at 6 23 11 pm" src="https://user-images.githubusercontent.com/2289/42729631-1164bd36-8793-11e8-9bf9-d2eeb9dd06e1.png">
<img width="785" alt="screen shot 2018-07-14 at 6 23 23 pm" src="https://user-images.githubusercontent.com/2289/42729632-11980b32-8793-11e8-9f8d-bf16c707f542.png">
## Installation
👉 [github.com/apps/semantic-pull-requests](https://github.com/apps/semantic-pull-requests)