Skip to content

Commit 1c8014a

Browse files
authored
chore: update pull request template (#5123)
Co-authored-by: Jacob Müller
1 parent c6623e6 commit 1c8014a

File tree

1 file changed

+11
-10
lines changed

1 file changed

+11
-10
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -8,32 +8,33 @@ A clear and concise description of what the pull request does.
88

99
**What kind of change does this PR introduce?** (check at least one)
1010

11-
- [ ] Bugfix
12-
- [ ] Feature
13-
- [ ] Enhancement
14-
- [ ] ARIA accessibility
15-
- [ ] Documentation update
11+
- [ ] Bugfix (fixes a boo-boo in the code) - `fix(...)`, requires a patch version update
12+
- [ ] Feature (adds a new feature to BootstrapVue) - `feat(...)`, requires a minor version update
13+
- [ ] Enhancement (augments an existing feature) - `feat(...)`, requires a minor version update
14+
- [ ] ARIA accessibility (fixes or improves ARIA accessibility) - `fix(...)`, requires a patch or minor version update
15+
- [ ] Documentation update (improves documentation or typo fixes) - `chore(docs)`, requires a patch version update
1616
- [ ] Other (please describe)
1717

1818
**Does this PR introduce a breaking change?** (check one)
1919

2020
- [ ] No
21-
- [ ] Yes (please describe)
21+
- [ ] Yes (please describe since breaking changes require a minor version update)
2222

2323
**The PR fulfills these requirements:**
2424

2525
- [ ] It's submitted to the `dev` branch, **not** the `master` branch
2626
- [ ] When resolving a specific issue, it's referenced in the PR's title (i.e. `[...] (fixes #xxx[,#xxx])`, where "xxx" is the issue number)
2727
- [ ] It should address only one issue or feature. If adding multiple features or fixing a bug and adding a new feature, break them into separate PRs if at all possible.
28-
- [ ] The title should follow the [**Conventional Commits**](https://www.conventionalcommits.org/) naming convention (i.e. `fix(alert): not alerting during SSR render`, `docs(badge): update pill examples`, `chore(docs): fix typo in README`, etc). **This is very important, as the `CHANGELOG` is generated from these messages.**
28+
- [ ] The title should follow the [**Conventional Commits**](https://www.conventionalcommits.org/) naming convention (i.e. `fix(alert): not alerting during SSR render`, `docs(badge): update pill examples`, `chore(docs): fix typo in README`, etc). **This is very important, as the `CHANGELOG` is generated from these messages, and determines the next version type (patch or minor).**
2929

3030
**If new features/enhancement/fixes are added or changed:**
3131

32-
- [ ] Includes documentation updates (including updating the component's `package.json` for slot and event changes)
32+
- [ ] Includes documentation updates
33+
- [ ] Includes component package.json meta section updates (prop, slot and event changes/updates)
3334
- [ ] Includes any needed TypeScript declaration file updates
34-
- [ ] New/updated tests are included and passing (if required)
35+
- [ ] New/updated tests are included and passing (required for new features and enhancements)
3536
- [ ] Existing test suites are passing
36-
- [ ] CodeCov for patch has met target
37+
- [ ] CodeCov for patch has met target (all changes/updates have been tested)
3738
- [ ] The changes have not impacted the functionality of other components or directives
3839
- [ ] ARIA Accessibility has been taken into consideration (Does it affect screen reader users or keyboard only users? Clickable items should be in the tab index, etc.)
3940

0 commit comments

Comments
 (0)