Skip to content

Commit 52cf7bb

Browse files
authored
[Docs] Minor changes to contribute page (#381)
1 parent bf7145d commit 52cf7bb

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
## Checklist
22
Thank you for contributing to `QuantumToolbox.jl`! Please make sure you have finished the following tasks before opening the PR.
33

4-
- [ ] Please read [Contributing to QuantumToolbox.jl](https://qutip.org/QuantumToolbox.jl/stable/resources/contributing).
4+
- [ ] Please read [Contributing to Quantum Toolbox in Julia](https://qutip.org/QuantumToolbox.jl/stable/resources/contributing).
55
- [ ] Any code changes were done in a way that does not break public API.
66
- [ ] Appropriate tests were added and tested locally by running: `make test`.
77
- [ ] Any code changes should be `julia` formatted by running: `make format`.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -175,7 +175,7 @@ Here we provide a brief performance comparison between `QuantumToolbox.jl` and o
175175

176176
You are most welcome to contribute to `QuantumToolbox.jl` development by forking this repository and sending pull requests (PRs), or filing bug reports at the issues page. You can also help out with users' questions, or discuss proposed changes in the [QuTiP discussion group](https://groups.google.com/g/qutip).
177177

178-
For more information about contribution, including technical advice, please see the [Contributing to QuantumToolbox.jl](https://qutip.org/QuantumToolbox.jl/stable/resources/contributing) section of the documentation.
178+
For more information about contribution, including technical advice, please see the [Contributing to Quantum Toolbox in Julia](https://qutip.org/QuantumToolbox.jl/stable/resources/contributing).
179179

180180
## Acknowledgements
181181

docs/src/resources/contributing.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [Contributing to QuantumToolbox.jl](@id doc-Contribute)
1+
# [Contributing to Quantum Toolbox in Julia](@id doc-Contribute)
22

33
## [Quick Start](@id doc-Contribute:Quick-Start)
44

@@ -32,6 +32,12 @@ make test
3232

3333
This command will automatically rebuild `Julia` and run the script located in `test/runtests.jl` (should cover both the original tests and the new test(s) you add).
3434

35+
The tests are divided into several test groups, where the group names are defined in the file `test/runtests.jl` with a variable `GROUP`. One can also run the test scripts just for a certain test group by adding an argument `GROUP=<test-group-name>` to the `make test` command. For example, to run the tests for group `Core`, one can use the following command:
36+
37+
```shell
38+
make GROUP=Core test
39+
```
40+
3541
## [Julia Code Format](@id doc-Contribute:Julia-Code-Format)
3642

3743
We use [`JuliaFormatter.jl`](https://github.com/domluna/JuliaFormatter.jl) to format all the source codes. The code style and extra formatting options is defined in the file `.JuliaFormatter.toml` in the repository.

0 commit comments

Comments
 (0)