From 3e0456291ff3dac9c8baf4a78d33d7d14fd3fc28 Mon Sep 17 00:00:00 2001 From: Steven Nguyen Date: Tue, 22 Nov 2022 09:42:29 -0800 Subject: [PATCH] Update PR template 1. Ask for why in description to help with troubleshooting in the future 2. Change related PRs to a list so it renders nicer 3. Remove changes.md task in favor of just using milestones to track changes 4. Add reminder to check if API specs need to be updated --- .github/PULL_REQUEST_TEMPLATE.md | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8522022bd..ab59c97ff 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -11,21 +11,17 @@ Happy contributing! ## What does this PR do? -(Provide a description of what this PR does.) +(Provide a description of what this PR does and why it's needed.) ## Test Plan -(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work.) +(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Screenshots may also be helpful.) ## Related PRs and Issues -(If this PR is related to any other PR or resolves any issue or related to any issue link all related PR and issues here.) +- (Related PR or issue) -### Have you added your change to the [Changelog](https://github.com/appwrite/appwrite/blob/master/CHANGES.md)? +## Checklist -(The CHANGES.md file tracks all the changes that make it to the `main` branch. Add your change to this file in the following format) -- One line description of your PR [#pr_number](Link to your PR) - -### Have you read the [Contributing Guidelines on issues](https://github.com/appwrite/appwrite/blob/master/CONTRIBUTING.md)? - -(Write your answer here.) +- [ ] Have you read the [Contributing Guidelines on issues](https://github.com/appwrite/appwrite/blob/master/CONTRIBUTING.md)? +- [ ] If the PR includes a change to an API's metadata (desc, label, params, etc.), does it also include updated API specs and example docs?