amazon-braket / amazon-braket-sdk-python

A Python SDK for interacting with quantum devices on Amazon Braket
https://aws.amazon.com/braket/
Apache License 2.0
294 stars 118 forks source link

doc: update PR title instructions #994

Closed rmshaffer closed 1 week ago

rmshaffer commented 1 month ago

Issue #, if available:

Description of changes: Instructions about commit messages should really refer to PR titles, since that's what ends up in the commit log.

Note - after getting approval and merging this, I'll make the same change in the several other Braket repos which contain this content in their CONTRIBUTING.md.

Testing done:

Merge Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your pull request.

General

Tests

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

codecov[bot] commented 1 month ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (fb307e3) to head (0670f96).

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #994 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 135 135 Lines 8948 8948 Branches 2010 2010 ========================================= Hits 8948 8948 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

Manvi-Agrawal commented 1 month ago

Thanks a ton @rmshaffer for taking up this small change to improve the checklist and the CONTRIBUTING doc.