From 7dc848a80e9d1da44689e1a87a1a4e74f635e80a Mon Sep 17 00:00:00 2001 From: Ellet Date: Wed, 17 Jul 2024 17:19:26 -0700 Subject: [PATCH] chore: update GitHub PR template (#2033) * chore: update GitHub PR template --- .github/PULL_REQUEST_TEMPLATE.md | 49 ++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 21 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e8931276..dd9e0d53 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,38 +1,45 @@ + + ## Description *Replace this paragraph with a description of what this PR is doing. If you're modifying existing behavior, describe the existing behavior, how this PR is changing it, and what motivated the change.* ## Related Issues -*Replace this paragraph with a list of issues related to this PR from the [issue database](https://github.com/singerdmx/flutter-quill/issues). Indicate, which of these issues are resolved or fixed by this PR.* + + + - *Fix #123* - *Related #456* -## Improvements - - -## Features - +## Type of Change -## Additional notes - + +Put an x in all the boxes that apply: -## Checklist +- [x] **Example:** -- [ ] I read the [Contributor Guide](https://github.com/singerdmx/flutter-quill/blob/master/CONTRIBUTING.md) and followed the process outlined there for submitting PRs. -- [ ] I titled the PR using [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0). -- [ ] I did not modify the `CHANGELOG.md` nor the package version in `pubspec.yaml` files. -- [ ] All existing and new tests are passing. -- [ ] I have run the commands in `./scripts/before_push.sh` and it all passed successfully +--> -## Breaking Change +- [ ] โœจ **New feature:** Adds new functionality without breaking existing features. +- [ ] ๐Ÿ› ๏ธ **Bug fix:** Resolves an issue without altering current behavior. +- [ ] ๐Ÿงน **Code refactor:** Code restructuring that does not affect behavior. +- [ ] โŒ **Breaking change:** Alters existing functionality and requires updates. +- [ ] ๐Ÿ“ **Documentation:** Updates or additions to documentation. +- [ ] ๐Ÿ—‘๏ธ **Chore:** Routine tasks, tests, or maintenance. +- [ ] โœ… **Build configuration change:** Changes to build or deploy processes. -Does your PR require developers to manually update their apps to accommodate your change? +## Suggestions -- [ ] Yes, this is a breaking change (please indicate that with a `!` in the title as explained in [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0)). -- [ ] No, this is *not* a breaking change. + \ No newline at end of file