diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 28ec373b7..265ff2ba5 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,26 +1,25 @@ -_Thanks for submitting a pull request. Please include the following information._ +**DO NOT CREATE A PULL REQUEST WITHOUT READING THESE INSTRUCTIONS** -**What I have done and why** +## Instructions +Thanks for submitting a pull request. To accept your pull request we need you do a few things: + +**If this is your first pull request** -_Include a summary of what your pull request contains, and why you have made these changes._ +- [Sign the contributors license agreement](https://cla.developers.google.com/) -Fixes # +**Ensure tests pass and code is formatted correctly** -**How I'm testing it** +- Run local tests on the `DemoDebug` variant by running `./gradlew testDemoDebug` +- Fix code formatting: `./gradlew --init-script gradle/init.gradle.kts spotlessApply` -_Choose at least one:_ -- Unit tests -- UI tests -- Screenshot tests -- N/A _(provide justification)_ +**Add a description** -**Do tests pass?** -- [ ] Run local tests on `DemoDebug` variant: `./gradlew testDemoDebug` -- [ ] Check formatting: `./gradlew --init-script gradle/init.gradle.kts spotlessApply` +We need to know what you've done and why you've done it. Include a summary of what your pull request contains, and why you have made these changes. Include links to any relevant issues which it fixes. -**Is this your first pull request?** -- [ ] [Sign the CLA](https://cla.developers.google.com/) -- [ ] Run `./tools/setup.sh` -- [ ] Import the code formatting style as explained in [the setup script](/tools/setup.sh#L40). +[Here's an example](https://github.com/android/nowinandroid/pull/1257). +**NOW DELETE THIS LINE AND EVERYTHING ABOVE IT** + +**What I have done and why** +\