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

Update pull request template #281

Merged
merged 2 commits into from
Apr 2, 2024
Merged

Conversation

kmcginnes
Copy link
Collaborator

@kmcginnes kmcginnes commented Mar 25, 2024

Description

Updates the GitHub pull request template to have an easier to read formatting and include helpful comments for open source contributors.

The format was heavily inspired from the nodejs.org GitHub repository template, which provides a great foundation to build upon.

Validation

The new format will look like this PR description.

  • Verify comments match the language desired
  • Verify links navigate to the right place
  • Ensure all information desired from a PR is mentioned
  • Ensure format is easy to understand

Related Issues

N/A

Check List

  • I confirm that my contribution is made under the terms of the Apache 2.0 license.
  • I have run pnpm run checks to ensure code compiles and meets standards.
  • I have run pnpm run test to check if all tests are passing.
  • I've covered new added functionality with unit tests if necessary.

Copy link

codecov bot commented Mar 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 12.02%. Comparing base (4d0f1fd) to head (f0cf8ef).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #281   +/-   ##
=======================================
  Coverage   12.02%   12.02%           
=======================================
  Files         410      410           
  Lines       30481    30481           
  Branches      764      764           
=======================================
  Hits         3665     3665           
  Misses      26483    26483           
  Partials      333      333           
Flag Coverage Δ
unittests 12.02% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@xiazcy xiazcy requested a review from michaelnchin April 2, 2024 17:36
Copy link
Member

@michaelnchin michaelnchin left a comment

Choose a reason for hiding this comment

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

Clean and comprehensive, I like it! Thanks @kmcginnes. Let's also consider adding this template to the other repositories we own, such as neptune-export.

@vkagamlyk vkagamlyk merged commit 12f6fc8 into aws:main Apr 2, 2024
3 checks passed
@kmcginnes kmcginnes deleted the update-pr-template branch April 2, 2024 19:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants