Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a checklist to PR template to catch potential downstream breakages #3015

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Thanks for your contribution! Please replace this text with a description of what this PR is changing or adding and why, list any relevant issues, and review the contribution guidelines below.

---

<details>
<summary>Downstream effects:</summary><br>
Review the following checklist to determine if your change could affect
downstream users or embedders of DartPad.
If your change matches any of the following situations, please
note why it won't affect downstream users or include a migration plan.

- [ ] Changes the behavior or default value of a query parameter.
- [ ] Removes a query parameter.
- [ ] Changes the mobile/narrow layout of DartPad.
- [ ] Touches the event handling and messaging with the parent window when embedded.
- [ ] Touches the loading of API doc samples or gists.
- [ ] Removes support for a package maintained by the Dart or Flutter team.
</details>

---

- [ ] I've reviewed the contributor guide and applied the relevant portions to this PR.

<details>
<summary>Contribution guidelines:</summary><br>

- See our [contributor guide](https://github.com/dart-lang/.github/blob/main/CONTRIBUTING.md) for general expectations for PRs.
- Large or significant changes should be discussed in an issue before creating a PR.
- Contributions to DartPad should follow the [Dart style guide](https://dart.dev/effective-dart) and use `dart format`.
- Potential breakages and accessibility should be considered with every change.

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.
</details>