Skip to content

Commit 809c62e

Browse files
committed
Merge remote-tracking branch 'origin/main' into features/blocking
2 parents 9e86fc9 + 1755cd4 commit 809c62e

4 files changed

Lines changed: 20 additions & 6 deletions

File tree

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
fail_fast: false
22
repos:
33
- repo: https://github.com/pre-commit/mirrors-mypy
4-
rev: v1.18.2 # Use the sha / tag you want to point at
4+
rev: v1.19.1 # Use the sha / tag you want to point at
55
hooks:
66
- id: mypy
77
additional_dependencies:
@@ -14,7 +14,7 @@ repos:
1414
- id: check-yaml
1515
- id: check-added-large-files
1616
- repo: https://github.com/astral-sh/ruff-pre-commit
17-
rev: v0.14.2
17+
rev: v0.14.11
1818
hooks:
1919
- id: ruff
2020
args: [ --fix ]

CONTRIBUTING.md

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,18 +122,29 @@ as shown below. Do not include attributes and methods of the parent class explic
122122
Sphinx autoapi will automatically generate links to the parent class documentation.
123123

124124

125-
6. **Commit Changes**: Commit your changes with a clear and concise commit message that describes what you have changed.
125+
6. **Test Changes**: Test all existing and added functionality.
126+
* ``ARTIST`` uses ``pytest`` for running the test suite. If you followed all of the above steps correctly, you already have the project and all dependencies installed. All of our tests are located in the ``tests/`` directory. Please also add your tests into the ``tests/`` directory.
127+
* To run all tests execute:
128+
```bash
129+
pytest tests/
130+
```
131+
* To run the tests with coverage:
132+
```bash
133+
pytest --cov=artist tests/
134+
```
135+
136+
7. **Commit Changes**: Commit your changes with a clear and concise commit message that describes what you have changed.
126137
Example:
127138
```bash
128139
git commit -m "add rotation control for heliostat"
129140
```
130141

131-
7. **Push Changes**: Push your changes to your fork on GitHub:
142+
8. **Push Changes**: Push your changes to your fork on GitHub:
132143
```bash
133144
git push origin features/your-feature-name
134145
```
135146

136-
8. **Open a Pull Request**: Go to the [original repository](https://github.com/ARTIST-Association/ARTIST.git) and click the "New Pull Request" button. Follow the guidelines in the template to submit your pull request. Resolve possible merge conflicts with the current main branch.
147+
9. **Open a Pull Request**: Go to the [original repository](https://github.com/ARTIST-Association/ARTIST.git) and click the "New Pull Request" button. Follow the guidelines in the template to submit your pull request. Resolve possible merge conflicts with the current main branch.
137148

138149
## Code of Conduct
139150

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -99,6 +99,9 @@ The ``ARTIST`` documentation includes:
9999
Check out our [contribution guidelines](CONTRIBUTING.md) if you are interested in contributing to the `ARTIST` project :fire:.
100100
Please also carefully check our [code of conduct](CODE_OF_CONDUCT.md) :blue_heart:.
101101

102+
## How to test our software
103+
For detailed instructions on testing, please refer to point 6 of the [contribution guidelines](CONTRIBUTING.md).
104+
102105
## Acknowledgments
103106
This work is supported by the [Helmholtz AI](https://www.helmholtz.ai/) platform grant.
104107

joss_paper/paper.bib

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ @article{Carballo:2025
8080
pages = {124574},
8181
year = {2025},
8282
issn = {0306-2619},
83-
doi = {https://doi.org/10.1016/j.apenergy.2024.124574},
83+
doi = {10.1016/j.apenergy.2024.124574},
8484
url = {https://www.sciencedirect.com/science/article/pii/S0306261924019573},
8585
author = {J.A. Carballo and J. Bonilla and N.C. Cruz and J. Fernández-Reche and J.D. Álvarez and A. Avila-Marin and M. Berenguel},
8686
}

0 commit comments

Comments
 (0)