You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+1-33Lines changed: 1 addition & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -53,39 +53,7 @@ benefit-decision-toolkit/
53
53
54
54
## Development Environment Setup
55
55
56
-
There are three ways to set up your environment. **Devbox is recommended** for local development.
57
-
58
-
### Option 1: GitHub Codespaces (Easiest)
59
-
60
-
No local installation required. Click the badge in the [README](README.md) to open a cloud-based development environment. Wait a few minutes for the first-time build to complete.
61
-
62
-
This is also a great way to test changes from a pull request — see the [Codespaces Testing Guide](docs/testing-prs-with-codespaces.md).
63
-
64
-
### Option 2: Devbox (Recommended for Local Development)
65
-
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`.
67
-
68
-
```bash
69
-
# Install Devbox + Nix and run one-time setup
70
-
bin/install-devbox && devbox run setup
71
-
```
72
-
73
-
**Tips**:
74
-
- Install the [Devbox direnv integration](https://www.jetify.com/docs/devbox/ide-configuration/direnv) to auto-activate the Devbox shell when you `cd` into the project
75
-
- VS Code users: install the [Devbox + Direnv extensions](https://www.jetify.com/docs/devbox/ide-configuration/vscode)
76
-
- Customize your shell by editing `.devboxrc` (not committed to git)
77
-
78
-
### Option 3: Devcontainer (VS Code)
79
-
80
-
Open the project in VS Code, install the `Dev Containers` extension, and run **"Dev Containers: Open Folder in Container..."** from the command palette. The container includes the full Devbox environment. Expect a longer first-time build.
81
-
82
-
### Option 4: DIY (Not Recommended)
83
-
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:
85
-
86
-
```bash
87
-
bin/setup
88
-
```
56
+
See the [README](README.md#development-setup) for full setup instructions covering Codespaces, Devbox, Devcontainer, and DIY options.
0 commit comments