Skip to content

Commit e5d87a5

Browse files
committed
docs: update pull request field
1 parent 2930b03 commit e5d87a5

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ Below is an explanation of each field in the configuration file:
235235

236236
- For `azuredevops`:
237237

238-
- `targetRefName` (required): The name of the target branch of the pull request. (e.g `main` or `refs/heads/main`).
238+
- `targetRefName` (optional): The name of the target branch of the pull request. (e.g `main` or `refs/heads/main`). Defaults to the remote repository default branch.
239239
- `title` (required): The title of the pull request.
240240
- `description` (optional): The description of the pull request.
241241
- `labels` (optional): Labels to be applied to the pull request.
@@ -247,7 +247,7 @@ Below is an explanation of each field in the configuration file:
247247
248248
- For `github`:
249249

250-
- `base` (required): The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository (e.g `main` or `refs/heads/main`).
250+
- `base` (optional): The name of the branch you want the changes pulled into. This should be an existing branch on the current repository. You cannot submit a pull request to one repository that requests a merge to a base of another repository (e.g `main` or `refs/heads/main`). Defaults to the remote repository default branch.
251251
- `title` (required): The title of the pull request.
252252
- `body` (optional): The body content of the pull request.
253253
- `maintainer_can_modify` (optional): Indicates whether maintainers can modify the pull request.

0 commit comments

Comments
 (0)