Skip to content

Commit 277df05

Browse files
committed
Update README.md
1 parent 81daf5b commit 277df05

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

README.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,15 +40,18 @@ This setup provides a Docker container that replicates the GitHub Actions
4040
environment (`Ubuntu 24.04`, `Python 3.12`) for running linting and testing
4141
workflows locally. Use it to validate your code before pushing to GitHub.
4242

43-
#### Prerequisites
43+
<details>
44+
<summary>Prerequisites</summary>
4445

4546
- Docker installed and running on your machine. Download from
4647
[docker.com](https://www.docker.com/get-started).
4748
- Your repo cloned locally (e.g., `git clone https://github.com/ikostan/python.git`).
4849
- Ensure `requirements.txt` exists in the repo root (even if empty).
4950
If you have a `.pylintrc`, it should be in the root as well.
51+
</details>
5052

51-
#### Building and Using the Docker Container
53+
<details>
54+
<summary>Building and Using the Docker Container</summary>
5255

5356
1. **Place the files**:
5457
- Save the `Dockerfile` and `run_ci_tests.sh` in your repo root.
@@ -103,8 +106,10 @@ workflows locally. Use it to validate your code before pushing to GitHub.
103106
ruff check --output-format=github .
104107
pytest . --verbose --ignore=solutions --log-cli-level=INFO
105108
```
109+
</details>
106110

107-
#### Notes
111+
<details>
112+
<summary>Notes</summary>
108113

109114
- **Failures**: If tests fail, fix your code and rebuild/run again. The env matches GitHub,
110115
so issues should align.
@@ -116,5 +121,6 @@ workflows locally. Use it to validate your code before pushing to GitHub.
116121
- **Cleanup**: Use `docker image prune` to remove old images if needed.
117122
- **Windows-Specific**: If mounting fails (e.g., permission issues), ensure your drive is shared
118123
in Docker Desktop settings. Use forward slashes in paths if needed, but Docker handles backslashes.
124+
</details>
119125
120126
**This keeps things simple:** build once, run tests locally, catch issues early.

0 commit comments

Comments
 (0)