Update PR Template #4754
Update PR Template #4754
Conversation
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
|
|
||
| ## 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) |
There was a problem hiding this comment.
| - (Related PR or issue) | |
| - (Related PRs or issues) |
There was a problem hiding this comment.
Thanks for the suggestion, but I made it singular because each bullet should be 1 issue or PR.
| - [ ] 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? |
There was a problem hiding this comment.
| - [ ] 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? | |
| - [ ] I have carefully read the [Contributing Guidelines on issues](https://github.com/appwrite/appwrite/blob/master/CONTRIBUTING.md) | |
| - [ ] I have updated the API specs and example docs, when changing the API's metadata (desc, label, params, etc.). |
There was a problem hiding this comment.
i would re-write this in order to be more "active" ;)
There was a problem hiding this comment.
Thanks for your suggestion, but, for now, I'd rather keep this closer to the original as that's what's in most of our other repos. I'll keep your suggestion in mind when we do a rehaul of all of our templates.
| @@ -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.) | |||
There was a problem hiding this comment.
Can we follow PR template like this
Objective
-Brief about the PR-
Description
-Describe the change-
How to Test
-Mention the steps to follow to verify the changes-
Screenshots
-Add screenshots-
Checklist
-[ ] Merged with latest branch
-[ ] Verified unit tests
-[ ] Code clean (Remove unnecessary codes)
-[ ] Attached all screenshots (Including FE)
I believe this will work for all the PRs like feature, bug fix. Please share your thoughts on this.
There was a problem hiding this comment.
Thanks for the suggestion, but I'd like to limit the scope of the change in this PR. If you feel strongly about your PR template, please submit an issue with info on why we should change to your suggested format.
What does this PR do?
Update PR Template to:
Test Plan
None
Related PRs and Issues
None
Have you added your change to the Changelog?
(The CHANGES.md file tracks all the changes that make it to the
mainbranch. Add your change to this file in the following format)Have you read the Contributing Guidelines on issues?
Yes