diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1b13e7ba..46c8abb0 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -10,9 +10,9 @@ _Put an `x` in the boxes that apply. You can also fill these out after creating #### General -- [ ] I have read the [CONTRIBUTING](https://github.com/aws/amazon-braket-pennylane-plugin-python/blob/main/CONTRIBUTING.md) doc -- [ ] I used the commit message format described in [CONTRIBUTING](https://github.com/aws/amazon-braket-pennylane-plugin-python/blob/main/CONTRIBUTING.md#commit-your-change) -- [ ] I have updated any necessary documentation, including [READMEs](https://github.com/aws/amazon-braket-pennylane-plugin-python/blob/main/README.md) and [API docs](https://github.com/aws/amazon-braket-pennylane-plugin-python/blob/main/CONTRIBUTING.md#documentation-guidelines) (if appropriate) +- [ ] I have read the [CONTRIBUTING](https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python/blob/main/CONTRIBUTING.md) doc +- [ ] I used the commit message format described in [CONTRIBUTING](https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python/blob/main/CONTRIBUTING.md#commit-your-change) +- [ ] I have updated any necessary documentation, including [READMEs](https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python/blob/main/README.md) and [API docs](https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python/blob/main/CONTRIBUTING.md#documentation-guidelines) (if appropriate) #### Tests diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5ca17601..5c57dca9 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -29,7 +29,7 @@ information to effectively respond to your bug report or contribution. We welcome you to use the GitHub issue tracker to report bugs or suggest features. -When filing an issue, please check [existing open](https://github.com/aws/amazon-braket-pennylane-plugin-python/issues) and [recently closed](https://github.com/aws/amazon-braket-pennylane-plugin-python/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20) issues to make sure somebody else hasn't already +When filing an issue, please check [existing open](https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python/issues) and [recently closed](https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20) issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful: * A reproducible test case or series of steps. @@ -183,7 +183,7 @@ You can then find the generated HTML files in `build/documentation/html`. ## Find Contributions to Work On -Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/amazon-braket-pennylane-plugin-python/labels/help%20wanted) issues is a great place to start. +Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python/labels/help%20wanted) issues is a great place to start. ## Code of Conduct @@ -200,6 +200,6 @@ If you discover a potential security issue in this project we ask that you notif ## Licensing -See the [LICENSE](https://github.com/aws/amazon-braket-pennylane-plugin-python/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. +See the [LICENSE](https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python/blob/main/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution. We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes. \ No newline at end of file diff --git a/README.rst b/README.rst index c97e63de..0e536ad9 100644 --- a/README.rst +++ b/README.rst @@ -9,7 +9,7 @@ Amazon Braket PennyLane Plugin :target: https://pypi.python.org/pypi/amazon-braket-pennylane-plugin .. image:: https://img.shields.io/github/actions/workflow/status/aws/amazon-braket-strawberryfields-plugin-python/python-package.yml?branch=main&logo=github :alt: Build Status - :target: https://github.com/aws/amazon-braket-pennylane-plugin-python/actions?query=workflow%3A%22Python+package%22 + :target: https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python/actions?query=workflow%3A%22Python+package%22 .. image:: https://codecov.io/gh/aws/amazon-braket-pennylane-plugin-python/branch/main/graph/badge.svg?token=VPPM8BJKW4 :alt: codecov :target: https://codecov.io/gh/aws/amazon-braket-pennylane-plugin-python @@ -26,7 +26,7 @@ The Amazon Braket PennyLane plugin offers four Amazon Braket quantum devices to .. header-start-inclusion-marker-do-not-remove -The `Amazon Braket Python SDK `__ is an open source +The `Amazon Braket Python SDK `__ is an open source library that provides a framework to interact with quantum computing hardware devices and simulators through Amazon Braket. @@ -77,7 +77,7 @@ that you installed or configured the following prerequisites: * Download and install `Python 3.8 `__ or greater. If you are using Windows, choose the option *Add Python to environment variables* before you begin the installation. * Make sure that your AWS account is onboarded to Amazon Braket, as per the instructions - `here `__. + `here `__. * Download and install `PennyLane `__: .. code-block:: bash @@ -97,7 +97,7 @@ pip install command in the root directory of the repository: .. code-block:: bash - git clone https://github.com/aws/amazon-braket-pennylane-plugin-python.git + git clone https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python.git cd amazon-braket-pennylane-plugin-python pip install . @@ -152,7 +152,7 @@ Integration tests ***************** To run the integration tests, set the ``AWS_PROFILE`` as explained in the amazon-braket-sdk-python -`README `__: +`README `__: .. code-block:: bash @@ -202,8 +202,8 @@ or applications built with the plugin. Support ======= -- **Source Code:** https://github.com/aws/amazon-braket-pennylane-plugin-python -- **Issue Tracker:** https://github.com/aws/amazon-braket-pennylane-plugin-python/issues +- **Source Code:** https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python +- **Issue Tracker:** https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python/issues - **General Questions:** https://quantumcomputing.stackexchange.com/questions/ask (add the tag amazon-braket) - **PennyLane Forum:** https://discuss.pennylane.ai diff --git a/doc/index.rst b/doc/index.rst index cf861c0e..573dcb2c 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -63,7 +63,7 @@ and simply replace ``'default.qubit'`` with the ``'braket.local.qubit'`` or the dev = qml.device('braket.XXX.qubit', [...]) Tutorials that showcase the Braket devices can be found on the `PennyLane website `_ -and the `Amazon Braket `_ examples GitHub repository. +and the `Amazon Braket `_ examples GitHub repository. .. toctree:: :maxdepth: 2 diff --git a/setup.py b/setup.py index 906861df..ae320804 100644 --- a/setup.py +++ b/setup.py @@ -73,7 +73,7 @@ TF_VERSION, ] }, - url="https://github.com/aws/amazon-braket-pennylane-plugin-python", + url="https://github.com/amazon-braket/amazon-braket-pennylane-plugin-python", author="Amazon Web Services", description=( "An open source framework for using Amazon Braket devices with the PennyLane" diff --git a/tox.ini b/tox.ini index 45e5bc90..135a258f 100644 --- a/tox.ini +++ b/tox.ini @@ -93,4 +93,4 @@ commands = [test-deps] deps = # If you need to test on a certain branch, add @ after.git - git+https://github.com/aws/amazon-braket-sdk-python.git + git+https://github.com/amazon-braket/amazon-braket-sdk-python.git