Skip to content

Commit 3e6fd3d

Browse files
authored
fix: update PR template for PR title naming convention. (#1263)
#### Details semantic-release uses PR title for deciding release version and it follows https://www.conventionalcommits.org/en/v1.0.0/. It is required to have terminal colon and space. So added this in PR checklist to verify PR title before merging it. ##### Motivation <!-- This can be as simple as "addresses issue #123" --> ##### Context <!-- Are there any parts that you've intentionally left out-of-scope for a later PR to handle? --> <!-- Were there any alternative approaches you considered? What tradeoffs did you consider? --> #### Pull request checklist <!-- If a checklist item is not applicable to this change, write "n/a" in the checkbox --> - [x] PR title respects [Conventional Commits](https://www.conventionalcommits.org) (starts with `fix:`, `feat:`, etc, and is suitable for user-facing release notes) - [ ] PR contains no breaking changes, **OR** description of both PR **and final merge commit** starts with `BREAKING CHANGE:` - [ ] (if applicable) Addresses issue: #0000 - [ ] Added relevant unit tests for your changes - [x] Ran `yarn precheckin` - [ ] Verified code coverage for the changes made
1 parent ef42d54 commit 3e6fd3d

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

.github/pull_request_template.md

+1
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
<!-- If a checklist item is not applicable to this change, write "n/a" in the checkbox -->
1717
- [ ] PR title respects [Conventional Commits](https://www.conventionalcommits.org) (starts with `fix:`, `feat:`, etc, and is suitable for user-facing release notes)
1818
- [ ] PR contains no breaking changes, **OR** description of both PR **and final merge commit** starts with `BREAKING CHANGE:`
19+
- [ ] Verify PR title and final merge commit contain space after `:` for example `feat(feature): feature title` otherwise it will not be considered by semantic-release for release.
1920
- [ ] (if applicable) Addresses issue: #0000
2021
- [ ] Added relevant unit tests for your changes
2122
- [ ] Ran `yarn precheckin`

0 commit comments

Comments
 (0)