From a4ee0ec4cf0010a361f3bad0a57f362edbc58441 Mon Sep 17 00:00:00 2001 From: xster Date: Tue, 2 Jun 2020 12:05:59 -0700 Subject: [PATCH] Add an engine PR template (#18721) --- .github/PULL_REQUEST_TEMPLATE.md | 52 ++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..50b5cfe568d --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,52 @@ +## 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 our [issue +database]. Indicate, which of these issues are resolved or fixed by this PR. +There should be at least one issue listed here.* + +## Tests + +I added the following tests: + +*Replace this with a list of the tests that you added as part of this PR. A +change in behaviour with no test covering it will likely get reverted +accidentally sooner or later. PRs must include tests for all +changed/updated/fixed behaviors. See [testing the engine] for instructions on +writing and running engine tests.* + +## Checklist + +Before you create this PR confirm that it meets all requirements listed below by checking the relevant checkboxes (`[x]`). This will ensure a smooth and quick review process. + +- [ ] I read the [contributor guide] and followed the process outlined there for submitting PRs. +- [ ] I signed the [CLA]. +- [ ] I read and followed the [C++, Objective-C, Java style guides] for the engine. +- [ ] I read the [tree hygiene] wiki page, which explains my responsibilities. +- [ ] I updated/added relevant documentation. +- [ ] All existing and new tests are passing. +- [ ] I am willing to follow-up on review comments in a timely manner. + +## Breaking Change + +Did any tests fail when you ran them? Please read [handling breaking changes]. + +- [ ] No, no existing tests failed, so this is *not* a breaking change. +- [ ] Yes, this is a breaking change. *If not, delete the remainder of this section.* + - [ ] I wrote a design doc: https://flutter.dev/go/template *Replace this with a link to your design doc's short link* + - [ ] I got input from the developer relations team, specifically from: *Replace with the names of who gave advice* + - [ ] I wrote a migration guide: https://flutter.dev/go/breaking-changes-template *Replace this with a link to a pull request that adds the migration guide to https://flutter.dev/docs/release/breaking-changes* + + +[issue database]: https://github.com/flutter/flutter/issues +[contributor guide]: https://github.com/flutter/flutter/wiki/Tree-hygiene#overview +[testing the engine]: https://github.com/flutter/flutter/wiki/Testing-the-engine +[C++, Objective-C, Java style guides]: https://github.com/flutter/engine/blob/master/CONTRIBUTING.md#style +[CLA]: https://cla.developers.google.com/ +[tree hygiene]: https://github.com/flutter/flutter/wiki/Tree-hygiene +[handling breaking changes]: https://github.com/flutter/flutter/wiki/Tree-hygiene#handling-breaking-changes