Skip to content

Commit 7ecf1ed

Browse files
mergify[bot]Krishan019Cryoris
authored
minor typing and grammar fix (Qiskit#15031) (Qiskit#15061)
* minor typing and grammar fix * Updated sentence flow and clarity suggested by reviewer updated sentence flow as suggested by @Cryoris for better sentence clarity --------- (cherry picked from commit a038f0b) Co-authored-by: Krishan Sharma <[email protected]> Co-authored-by: Julien Gacon <[email protected]>
1 parent 33fef5f commit 7ecf1ed

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ building and installing from source you will need a Rust compiler installed. You
117117
using rustup: https://rustup.rs/ which provides a single tool to install and
118118
configure the latest version of the rust compiler.
119119
[Other installation methods](https://forge.rust-lang.org/infra/other-installation-methods.html)
120-
exist too. For Windows users, besides rustup, you will also need install
120+
exist too. For Windows users, besides rustup, you will also need to install
121121
the Visual C++ build tools so that Rust can link against the system c/c++
122122
libraries. You can see more details on this in the
123123
[rustup documentation](https://rust-lang.github.io/rustup/installation/windows-msvc.html).
@@ -135,9 +135,9 @@ If you'd like to use an editable install with an optimized binary you can
135135
run `python setup.py build_rust --release --inplace` after you install in
136136
editable mode to recompile the rust extensions in release mode.
137137

138-
Note that in order to run `python setup.py ...` commands you need have build
139-
dependency packages installed in your environment, which are listed in the
140-
`pyproject.toml` file under the `[build-system]` section.
138+
Note that in order to run `python setup.py ...` commands you need to have the
139+
build dependency packages, which are listed in the `pyproject.toml` file under
140+
the `[build-system]` section, installed in your environment.
141141

142142
### Compile time options
143143

@@ -538,7 +538,7 @@ you will need to check that your changes don't break any snapshot tests, and add
538538
new tests where necessary. You can do this as follows:
539539

540540
1. Make sure you have pushed your latest changes to your remote branch.
541-
2. Go to link: `https://mybinder.org/v2/gh/<github_user>/<repo>/<branch>?urlpath=apps/test/ipynb/mpl_tester.ipynb`. For example, if your GitHub username is `username`, your forked repo has the same name the original, and your branch is `my_awesome_new_feature`, you should visit https://mybinder.org/v2/gh/username/qiskit/my_awesome_new_feature?urlpath=apps/test/ipynb/mpl_tester.ipynb.
541+
2. Go to link: `https://mybinder.org/v2/gh/<github_user>/<repo>/<branch>?urlpath=apps/test/ipynb/mpl_tester.ipynb`. For example, if your GitHub username is `username`, your forked repo has the same name as the original, and your branch is `my_awesome_new_feature`, you should visit https://mybinder.org/v2/gh/username/qiskit/my_awesome_new_feature?urlpath=apps/test/ipynb/mpl_tester.ipynb.
542542
This opens a Jupyter Notebook application running in the cloud that automatically runs
543543
the snapshot tests (note this may take some time to finish loading).
544544
3. Each test result provides a set of 3 images (left: reference image, middle: your test result, right: differences). In the list of tests the passed tests are collapsed and failed tests are expanded. If a test fails, you will see a situation like this:
@@ -766,12 +766,12 @@ code formatting. You can simply run `cargo fmt` (if you installed Rust with the
766766
default settings using `rustup`), and it will update the code formatting automatically to
767767
conform to the style guidelines. This is very similar to running `tox -eblack` for Python code. For lint checking, Qiskit uses [clippy](https://github.com/rust-lang/rust-clippy) which can be invoked via `cargo clippy`.
768768

769-
Rust lint and formatting checks are included in the the `tox -elint` command. For CI to pass you will need both checks to pass without any warnings or errors. Note that this command checks the code but won't apply any modifications, if you need to update formatting, you'll need to run `cargo fmt`.
769+
Rust lint and formatting checks are included in the `tox -elint` command. For CI to pass you will need both checks to pass without any warnings or errors. Note that this command checks the code but won't apply any modifications, if you need to update formatting, you'll need to run `cargo fmt`.
770770

771771
### C style and lint
772772

773773
Qiskit uses [clang-format](https://clang.llvm.org/docs/ClangFormat.html) to format C code.
774-
The style is based on LLVM, with some few Qiskit-specific adjustments.
774+
The style is based on LLVM, with a few Qiskit-specific adjustments.
775775
To check whether the C code conforms to the style guide, you can run `make cformat`. This check
776776
will need to execute without any warnings or errors for CI to pass.
777777
Automatic formatting can be applied by `make fix_cformat`.

0 commit comments

Comments
 (0)