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