You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Rename Quantum Serverless to Qiskit Serverless (#1309)
* Rename Quantum Serverless to Qiskit Serverless
* Fixed docker-compose for client tests
* Use in the job old reference to quantum
* This job requires old reference
* Update configuration with proxy image
Copy file name to clipboardexpand all lines: CONTRIBUTING.md
+15-15
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,8 @@
1
1
# Contributing
2
2
3
-
Regardless if you are part of the core team or an external contributor, welcome and thank you for contributing to Quantum Serverless!
3
+
Regardless if you are part of the core team or an external contributor, welcome and thank you for contributing to Qiskit Serverless!
4
4
5
-
In Quantum Serverless, we aim at creating an excellent work-space where all of us can feel welcomed, useful, respected and valued. If you are thinking to contribute to this project, you agree to abide by our [code of conduct](CODE_OF_CONDUCT.md) which we strongly recommend you read before continuing.
5
+
In Qiskit Serverless, we aim at creating an excellent work-space where all of us can feel welcomed, useful, respected and valued. If you are thinking to contribute to this project, you agree to abide by our [code of conduct](CODE_OF_CONDUCT.md) which we strongly recommend you read before continuing.
6
6
7
7
Following these guidelines communicates you value the time and effort of the core contributors and maintainers of this site and so, thank you!
8
8
@@ -31,7 +31,7 @@ Following these guidelines communicates you value the time and effort of the cor
31
31
32
32
## Start contributing
33
33
34
-
This repository is for developing and maintaining the Quantum Serverless project.
34
+
This repository is for developing and maintaining the Qiskit Serverless project.
35
35
36
36
There are many ways of contributing: from catching a typo to coming up with a way
37
37
of improving performance or accessibility; you can open an issue, or you can prepare
@@ -41,7 +41,7 @@ submitting pull requests.
41
41
42
42
## Before you start
43
43
44
-
Contributing to Quantum Serverless assumes you have some level
44
+
Contributing to Qiskit Serverless assumes you have some level
45
45
of [Git](https://git-scm.com) knowledge. For external contributors, a basic understanding
46
46
of repositories, remotes, branches and commits is needed. For core contributors, you
47
47
should know about resolving conflicts and rebasing too.
@@ -51,7 +51,7 @@ There are tons of useful resources about Git [out there](https://try.github.io/)
51
51
52
52
## Opening issues
53
53
54
-
You can [open 3 types of issues](https://github.com/Qiskit-Extensions/quantum-serverless/issues/new/choose):
54
+
You can [open 3 types of issues](https://github.com/Qiskit-Extensions/qiskit-serverless/issues/new/choose):
55
55
56
56
* Bug reports: for reporting a misfunction. Provide steps to reproduce and expected behaviour.
57
57
* Enhancement request: to suggest improvements to the current code.
@@ -70,17 +70,17 @@ Security vulnerabilities must be privately reported by following our [Security P
70
70
71
71
You'll need to install these tools on your development environment:
72
72
73
-
1.[python](https://www.python.org/): the language quantum-serverless is written in (Note that we currently support Python >=3.8,<3.11).
73
+
1.[python](https://www.python.org/): the language qiskit-serverless is written in (Note that we currently support Python >=3.8,<3.11).
74
74
1.[git](https://git-scm.com/): for source control
75
75
1.[docker](https://docs.docker.com/engine/install/) or [podman](https://podman.io/): for building dev environment
76
76
1.[kubectl](https://kubectl.docs.kubernetes.io/): for interacting with Kubernetes clusters
77
-
1.[helm](https://helm.sh/): to install quantum-serverless on Kubernetes
77
+
1.[helm](https://helm.sh/): to install qiskit-serverless on Kubernetes
78
78
1.[tox](https://tox.wiki/en): to run tests and build the documentation
79
79
80
80
Note: Installing the `pip` and `venv` python libraries will also be useful
81
81
82
82
#### For non-Linux users
83
-
To simplify the steps required to build and deploy quantum-serverless, we recommend the use of virtual machines for runtime containers.
83
+
To simplify the steps required to build and deploy qiskit-serverless, we recommend the use of virtual machines for runtime containers.
84
84
85
85
If you are on a Windows machine, it is recommended to use [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install).
86
86
@@ -109,10 +109,10 @@ nerdctl images
109
109
### Deciding what to work on
110
110
111
111
To give our collaborators an idea of where the team needs help, we use the
@@ -150,7 +150,7 @@ This repository contains several projects with different technologies. Depending
150
150
-`helm dependency build` for helm (Before running this command, make sure to check for helm configuration instructions specific to your selected project charts).
151
151
-`terraform init` for terraform.
152
152
153
-
To set up a local development environment for the quantum-serverless components (including the gateway, repository, ray nodes, etc.) using the latest changes you've made, use `docker compose` or `podman-compose`.
153
+
To set up a local development environment for the qiskit-serverless components (including the gateway, repository, ray nodes, etc.) using the latest changes you've made, use `docker compose` or `podman-compose`.
154
154
155
155
To build the images, run the following command from the root directory:
156
156
@@ -220,7 +220,7 @@ git rebase main issue-1234-new-feature
220
220
221
221
Our team upholds the philosophy that a healthy codebase will include the proper amount of testing.
222
222
From the project you are working on, you can run tests with `tox -epy310`.
223
-
Note if you run this command from quantum-serverless top directory, it will build the project documentation.
223
+
Note if you run this command from qiskit-serverless top directory, it will build the project documentation.
224
224
For detailed testing guidelines using tox environments, please refer to [this documentation](./client/tests/README.md).
225
225
226
226
As a part of the development backlog planning, we have internal discussions to determine which scenarios should be
0 commit comments