Skip to content

Commit 793a795

Browse files
committed
feat(create-pr): Add docs
1 parent 7a12681 commit 793a795

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ The following parameters can be used for additional control over when it is safe
148148
| body | Description of the PR | N/A | ✔️ |
149149
| base | Base ref to initiate pull request onto | N/A | ❌ |
150150
| branch_name | Name of the branch to be created. Use this parameter if you want the helper to create a new branch for you. | N/A | ❌ |
151-
| commit_message | Text used when creating a commit if branch_name is given | Automated PR creation | ❌ |
151+
| commit_message | Text used when creating a commit if branch_name is given. Similar to `git commit -m "<commit_message>"` | Automated PR creation | ❌ |
152152
| head | Head ref to initiate pull request from. If branch_name is provided it'll be the value of head | N/A | ❌ |
153153
| return_full_payload | Return full payload from GitHub rather than a trimmed-down version of the response | N/A | ❌ |
154154

0 commit comments

Comments
 (0)