riot-ci/RIOT
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

pr_check: fix README

Browse Source
This commit is contained in:
Martine Lenders 2021-01-08 15:21:44 +01:00
parent 2e0e5a5477
commit 741aaf9a38
No known key found for this signature in database
GPG Key ID: CCD317364F63286F
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
dist/tools/pr_check/README.md vendored
View File

@ -1,18 +1,17 @@
# About # About
This script checks if a Pull Request needs squashing or if it is waiting for This script checks if a Pull Request needs squashing.
another Pull Request.
# Usage # Usage
```bash ```bash
./check.sh [<master branch>] ./check.sh [<branch>]
``` ```
The optional `<master branch>` parameter refers to the branch the pull request's The `<branch>` parameter refers to the branch the pull request's branch branched
branch branched from. The script will output all commits marked as squashable from. The script will output all commits marked as squashable from `HEAD` to the
from `HEAD` to the merge-base with `<master branch>`. The default for merge-base with `<branch>`. The default for `<branch>` is `master`.
`<master branch>` is `master`.
A commit is marked as squashable if it contains the keywords SQUASH or FIX A commit is marked as squashable if it contains the keywords SQUASH, FIX or
(case insensitive) within the first five characters of it's subject title. REMOVE ME (case insensitive) within the first five characters of it's subject
title.