Skip to content

Commit ed6efaf

Browse files
committed
fix: correct Java version and builder-api port details in CONTRIBUTING.md
- devbox.json only provides JDK 21; library-api targets Java 17 via Maven --release 17, not a separate JDK install - Add builder-api (port 8081) to Service URLs table - Clarify DIY setup requires JDK 21 only, not both 17 and 21
1 parent 6cfd63d commit ed6efaf

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ benefit-decision-toolkit/
4747
└── process-compose.yml # Multi-service orchestration for local dev
4848
```
4949

50-
**Important**: `library-api` uses **Java 17 + Quarkus 2.16.10** (required for Kogito), while `builder-api` uses **Java 21 + Quarkus 3.23.0**. Do not mix them up.
50+
**Important**: `library-api` targets **Java 17 bytecode + Quarkus 2.16.10** (required for Kogito), while `builder-api` uses **Java 21 + Quarkus 3.23.0**. Devbox provides JDK 21 for both — Maven compiles `library-api` with `--release 17` automatically.
5151

5252
---
5353

@@ -63,7 +63,7 @@ This is also a great way to test changes from a pull request — see the [Codesp
6363

6464
### Option 2: Devbox (Recommended for Local Development)
6565

66-
[Devbox](https://www.jetify.com/docs/devbox/) manages all project dependencies (Java 17, Java 21, Maven, Node.js 22, Firebase Tools, Bruno, etc.) using Nix, ensuring a consistent environment across machines.
66+
[Devbox](https://www.jetify.com/docs/devbox/) manages all project dependencies (JDK 21, Maven, Node.js 22, Firebase Tools, Bruno, etc.) using Nix, ensuring a consistent environment across machines. A single JDK 21 covers both services — Maven handles the Java 17 target for `library-api` automatically via `--release 17`.
6767

6868
```bash
6969
# Install Devbox + Nix and run one-time setup
@@ -81,7 +81,7 @@ Open the project in VS Code, install the `Dev Containers` extension, and run **"
8181

8282
### Option 4: DIY (Not Recommended)
8383

84-
Manually install the dependencies listed in `devbox.json` (JDK 17, JDK 21, Maven, Node.js 22, Firebase Tools 14.27.0, Bruno, process-compose), then run:
84+
Manually install the dependencies listed in `devbox.json` (JDK 21, Maven, Node.js 22, Firebase Tools 14.27.0, Bruno, process-compose), then run:
8585

8686
```bash
8787
bin/setup
@@ -131,6 +131,7 @@ cd builder-frontend && npm run dev
131131
| Service | URL |
132132
|---|---|
133133
| builder-frontend | http://localhost:5173 |
134+
| builder-api | http://localhost:8081 |
134135
| library-api | http://localhost:8083 |
135136
| library-api Swagger UI | http://localhost:8083/q/swagger-ui |
136137
| Firebase Emulator UI | http://localhost:4000 |

0 commit comments

Comments
 (0)