Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: reformat pull request template #28923

Merged
merged 3 commits into from
Jan 31, 2024
Merged

Conversation

gracelu0
Copy link
Contributor

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

@aws-cdk-automation aws-cdk-automation requested a review from a team January 29, 2024 23:35
@github-actions github-actions bot added the p2 label Jan 29, 2024
@mergify mergify bot added the contribution/core This is a PR that came from AWS. label Jan 29, 2024
Copy link
Contributor

@GavinZZ GavinZZ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

@aws-cdk-automation aws-cdk-automation added the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 30, 2024
@gracelu0
Copy link
Contributor Author

gracelu0 commented Jan 30, 2024

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 Checklist heading as well to keep it organized. I believe the entire template used to be a long checklist but it got removed since people weren't really using it - something to keep in mind before we decide to add more checklist items.

@GavinZZ
Copy link
Contributor

GavinZZ commented Jan 30, 2024

I believe the entire template used to be a long checklist but it got removed since people weren't really using it - something to keep in mind before we decide to add more checklist items.

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 USEFUL LINKS section if we find it not useful in the future and just put a couple of useful links CDK has.

Copy link
Contributor

mergify bot commented Jan 30, 2024

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).

@aws-cdk-automation aws-cdk-automation removed the pr/needs-maintainer-review This PR needs a review from a Core Team Member label Jan 30, 2024
Copy link
Contributor

mergify bot commented Jan 30, 2024

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).

@GavinZZ
Copy link
Contributor

GavinZZ commented Jan 30, 2024

@mergify update

Copy link
Contributor

mergify bot commented Jan 30, 2024

update

❌ Mergify doesn't have permission to update

For security reasons, Mergify can't update this pull request. Try updating locally.
GitHub response: refusing to allow a GitHub App to create or update workflow .github/workflows/repo-metrics.yml without workflows permission

@paulhcsun
Copy link
Contributor

@Mergifyio update

Copy link
Contributor

mergify bot commented Jan 31, 2024

update

✅ Branch has been successfully updated

@moelasmar
Copy link
Contributor

do you think we should add a section for the Breaking changes as mentioned here?

@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • CodeBuild project: AutoBuildv2Project1C6BFA3F-wQm2hXv2jqQv
  • Commit ID: 69d2b7f
  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@gracelu0
Copy link
Contributor Author

do you think we should add a section for the Breaking changes as mentioned here?

I think that's a good idea since there's a specific format required, I can add it

Copy link
Contributor

mergify bot commented Jan 31, 2024

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 mergify bot merged commit 492ef12 into aws:main Jan 31, 2024
9 checks passed
SankyRed pushed a commit that referenced this pull request Feb 8, 2024
### 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*
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS. p2
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants