update doc to remind contributors to activate hermit and document minimal npm and node version (#6727)

This commit is contained in:
Lifei Zhou
2026-01-30 03:32:19 +11:00
committed by GitHub
parent 542c6cb0fd
commit e89b7d8159
4 changed files with 16 additions and 8 deletions
+11 -5
View File
@@ -41,9 +41,16 @@ If you use Goose, Copilot, Claude, or other AI tools to help with your PRs:
## Prerequisites
goose includes Rust binaries alongside an electron app for the GUI. To work
on the Rust backend, you will need to [install Rust and cargo][rustup]. To work
on the App, you will also need to [install node and npm][nvm] - we recommend through nvm.
goose includes Rust binaries alongside an electron app for the GUI.
We use [Hermit][hermit] to manage development dependencies (Rust, Node, npm, just, etc.).
Activate Hermit when entering the project:
```bash
source bin/activate-hermit
```
Or add [shell hook auto-activation](https://cashapp.github.io/hermit/usage/shell/#shell-hooks) so Hermit activates automatically when you `cd` into the project (recommended).
We provide a shortcut to standard commands using [just][just] in our `justfile`.
@@ -285,8 +292,7 @@ Then you can view your traces at http://localhost:3000
This project follows the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification for PR titles. Conventional Commits make it easier to understand the history of a project and facilitate automation around versioning and changelog generation.
[issues]: https://github.com/block/goose/issues
[rustup]: https://doc.rust-lang.org/cargo/getting-started/installation.html
[nvm]: https://github.com/nvm-sh/nvm
[hermit]: https://cashapp.github.io/hermit/
[just]: https://github.com/casey/just?tab=readme-ov-file#installation
## Developer Certificate of Origin
+1 -1
View File
@@ -1 +1 @@
registry=https://registry.npmjs.org/
registry=https://registry.npmjs.org/
+2 -1
View File
@@ -115,7 +115,8 @@
"vitest": "^4.0.17"
},
"engines": {
"node": "^24.0.0"
"node": "^24.10.0",
"npm": "^11.6.1"
}
},
"node_modules/@acemir/cssom": {
+2 -1
View File
@@ -4,7 +4,8 @@
"version": "1.21.0",
"description": "Goose App",
"engines": {
"node": "^24.0.0"
"node": "^24.10.0",
"npm": "^11.6.1"
},
"main": ".vite/build/main.js",
"scripts": {