From ea20df0fd8344da8213f4cdb97f2a4f2ffb6f132 Mon Sep 17 00:00:00 2001 From: Jacob Trimble Date: Mon, 22 Mar 2021 11:56:57 -0700 Subject: [PATCH] docs: Update PR template. - Puts the description info in a comment. - Adds comments to screenshots section. - Removes the comments telling people to remove checkbox lines. - Adds new checklist items for CLA/build/test. Change-Id: I2d3b66c9b1a16eb489f8d65526a17c4ad4e4fae9 --- .github/pull_request_template.md | 32 +++++++++++++++++++++----------- 1 file changed, 21 insertions(+), 11 deletions(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index fac24c543..a4c423295 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,28 +1,38 @@ ## Description -Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change. + -Fixes # (issue) ## Screenshots (optional) -## Type of change + - + +## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) +- [ ] Breaking change (fix or feature that would cause existing functionality to + not work as expected) - [ ] This change requires a documentation update ## Checklist: - - +- [ ] I have signed the Google CLA - [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code -- [ ] I have commented my code, particularly in hard-to-understand areas - [ ] I have made corresponding changes to the documentation -- [ ] My changes generate no new warnings - [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing unit tests pass locally with my changes +- [ ] I have verified my change on multiple browsers on different platforms +- [ ] I have run `./build/all.py` and the build passes +- [ ] I have run `./build/test.py` and all tests pass