Skip to content

Commit 3171922

Browse files
authored
Merge branch 'main' into git-stunts
Signed-off-by: James Ross <james@flyingrobots.dev>
2 parents 7e1ee2f + eeddded commit 3171922

1 file changed

Lines changed: 13 additions & 5 deletions

File tree

README.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -54,8 +54,19 @@ The tests create, destroy, and manipulate Git repositories. Running low-level pl
5454

5555
## Development
5656

57+
### ⚠️ SAFETY WARNING
58+
5759
We use Docker Compose to ensure a consistent, safe environment.
5860

61+
**If you clone this repo and want to run the tests, ALWAYS run them in Docker.**
62+
63+
The tests create, destroy, and manipulate Git repositories. While we try to use temporary directories, running low-level plumbing commands against your host filesystem is a risk you shouldn't take.
64+
65+
We provided a safe harness:
66+
```bash
67+
npm test
68+
# (This automatically runs ./test/run-docker.sh)
69+
```
5970
### Start the Server (Dev Mode)
6071
```bash
6172
npm run dev
@@ -129,9 +140,6 @@ Publishing fast-forwards `refs/_blog/published/<slug>` to match the draft.
129140
git cms publish hello-world
130141
```
131142

132-
## The Theory
133-
134-
See the blog post: [Git Stunts: Making Linus Roll His Eyes](https://flyingrobots.dev/posts/git-stunts)
135-
136143
## License
137-
MIT
144+
145+
Copyright © 2026 James Ross. This software is licensed under the [Apache License](./LICENSE), Version 2.0

0 commit comments

Comments
 (0)