chore: reformat pull request template#28923
Conversation
There was a problem hiding this comment.
nit: I really liked SAM-Transform repo's PR template where we issues as a section and users can always add more detail to the issue section to explain the issue.
### Issue #, if available
Closes #<issue number here>.
Maybe make the checklist its own section and we can append to it in the future
### Checklist
- [ ] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and the [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md)
I think having the issue at the top is a good idea. I can add a |
That's a good point actually, I tend to ignore all checklist most of the time as well. Maybe we could have it instead as a |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
|
@mergify update |
❌ Mergify doesn't have permission to updateDetailsFor security reasons, Mergify can't update this pull request. Try updating locally. |
|
@Mergifyio update |
✅ Branch has been successfully updated |
|
do you think we should add a section for the Breaking changes as mentioned here? |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
I think that's a good idea since there's a specific format required, I can add it |
|
Thank you for contributing! Your pull request will be updated from main and then merged automatically (do not update manually, and be sure to allow changes to be pushed to your fork). |
### Reason for this change I noticed that some PRs only link the issue or have really long paragraph descriptions which can be hard to follow and understand the why/what regarding the changes. ### Description of changes Reformatting the pull request template with section headings. This enforces PR descriptions to follow a uniform format and include the information we want. Should make it easier/more efficient to review PRs. ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license*
Reason for this change
I noticed that some PRs only link the issue or have really long paragraph descriptions which can be hard to follow and understand the why/what regarding the changes.
Description of changes
Reformatting the pull request template with section headings. This enforces PR descriptions to follow a uniform format and include the information we want. Should make it easier/more efficient to review PRs.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license