Skip to content

Commit

Permalink
Add tagging options for PR types and update checklist. (#238)
Browse files Browse the repository at this point in the history
- Add tagging option for breaking changes in PRs.
- Include tagging options for features, documentation, and refactoring.
- Update checklist items based on the new tagging options.
  • Loading branch information
forntoh authored Oct 7, 2024
2 parents 00053e6 + 7ceb1f2 commit 5fc8d64
Showing 1 changed file with 22 additions and 3 deletions.
25 changes: 22 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@

- [ ] I have kept this PR in draft until all the required tasks are completed.
- [ ] I have reviewed the [contributing guidelines](/CONTRIBUTING.md) for this project.
- [ ] I have tagged this PR with `breaking-change` if it introduces a breaking change.
- [ ] I have checked that this PR does not introduce any breaking changes unless explicitly stated.
- [ ] I have checked that changes generate no new warnings.
- [ ] I have performed a self-review of my own code
Expand All @@ -38,14 +39,32 @@
- [ ] I have added a link to the bug in the description.
- [ ] I have added tests that prove my fix is effective.

#### Feature/Enhancement
#### Feature

<!-- Delete this section if it doesn't apply to your PR. -->

- [ ] **This PR is a new feature/enhancement**
- [ ] I have tagged this PR with `enhancement`.
- [ ] **This PR is a new feature**
- [ ] I have tagged this PR with `feature`.
- [ ] I have included an example sketch file.
- [ ] I have commented my code thoroughly.
- [ ] I have added documentation for the new feature.
- [ ] I have [generated](/docs/README.md) and reviewed the documentation locally.
- [ ] I have created a [functionality test](/test/README.md) to validate the new feature.

#### Documentation

<!-- Delete this section if it doesn't apply to your PR. -->

- [ ] **This PR is documentation only.**
- [ ] I have tagged this PR with `documentation`.
- [ ] I have [generated](/docs/README.md) and reviewed the documentation locally.

#### Refactor/Enhancement

<!-- Delete this section if it doesn't apply to your PR. -->

- [ ] **This PR is a code refactor.**
- [ ] I have tagged this PR with `enhancement`.
- [ ] I have made changes to the code that improve readability/performance/maintainability.
- [ ] I have added documentation for the changes if necessary.
- [ ] I have [generated](/docs/README.md) and reviewed the documentation locally if necessary.

0 comments on commit 5fc8d64

Please sign in to comment.