Skip to content

Commit 7d0dce4

Browse files
committed
add example screenshot
1 parent 8511c20 commit 7d0dce4

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed
80.3 KB
Loading

plugins/filters/generateDescription/reference.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
## generateDescription
44
A gitStream plugin to auto-generate pull request descriptions based on commit messages and other criteria.
55

6-
**Returns**: <code>Object</code> - Returns the generated PR description.
7-
**License**: MIT
6+
![Example PR description](screenshots/generate-pr-description-example.png)
7+
8+
**Returns**: <code>Object</code> - Returns the generated PR description.
9+
**License**: MIT
810

911
| Param | Type | Description |
1012
| --- | --- | --- |
@@ -14,7 +16,7 @@ A gitStream plugin to auto-generate pull request descriptions based on commit me
1416
| source | <code>Object</code> | The source object containing diff information. |
1517
| callback | <code>function</code> | The callback function. |
1618

17-
**Example**
19+
**Example**
1820
```js
1921
{{ branch | generateDescription(pr, repo, source) }}
2022
```

0 commit comments

Comments
 (0)