Skip to content

Commit 9b59912

Browse files
committed
README.md: add an example
Signed-off-by: Trevor Gamblin <[email protected]>
1 parent d7de603 commit 9b59912

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,17 @@ Then install with pip:
3737
pip install .
3838
```
3939

40+
## Examples
41+
42+
Test a patch (the sample file is generated using `git format-patch` on commit d7de60340ec9 in this repository):
43+
44+
```console
45+
(venv) tgamblin@workbox:~/git/patchtest2$ patchtest --patch 0001-README.md-update-Installation-instructions.patch
46+
PASS: test_mbox_signed_off_by_presence on [PATCH] README.md: update Installation instructions
47+
PASS: test_mbox_shortlog_format on [PATCH] README.md: update Installation instructions
48+
FAIL: test_mbox_commit_message_presence on [PATCH] README.md: update Installation instructions (Please include a commit message on your patch explaining the change)
49+
```
50+
4051
## License
4152

4253
`patchtest2` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

0 commit comments

Comments
 (0)