diff options
| author | matt korwel <[email protected]> | 2025-06-17 00:09:23 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-06-17 00:09:23 -0700 |
| commit | bc3fa71234638abd623479d81b52302c21630e87 (patch) | |
| tree | 575f2557b784a781457ec64b78d73f02f1be6536 | |
| parent | 137baa0a07948905570461700f377f1427b91078 (diff) | |
Update CONTRIBUTING.md (#1130)
| -rw-r--r-- | CONTRIBUTING.md | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2745dc87..934efaa6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -74,6 +74,10 @@ Your PR should have a clear, descriptive title and a detailed description of the In the PR description, explain the "why" behind your changes and link to the relevant issue (e.g., `Fixes #123`). +## Forking + +If you are forking the repository you will be able to run the Built, Test and Integration test workflows. However in order to make the integration tests run you'll need to add a [Github Repository Secret](<[url](https://docs.github.com/en/actions/security-for-github-actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository)>) with a value of `GEMII_API_KEY` and set that to a valid API key that you have available. Your key and secret it private to your repo; noone with out access can see your key and you cannot see any secrets related to this repo. + ## Development Setup and Workflow This section guides contributors on how to build, modify, and understand the development setup of this project. @@ -218,6 +222,7 @@ For more detailed architecture, see `docs/architecture.md`. ### VS Code: +0. Run the CLI to interactively debug in VS Code with `F5` 1. Start the CLI in debug mode from the root directory: ```bash npm run debug @@ -225,7 +230,7 @@ For more detailed architecture, see `docs/architecture.md`. This command runs `node --inspect-brk dist/gemini.js` within the `packages/cli` directory, pausing execution until a debugger attaches. You can then open `chrome://inspect` in your Chrome browser to connect to the debugger. 2. In VS Code, use the "Attach" launch configuration (found in `.vscode/launch.json`). -Alternatively, you can use the "Launch Program" configuration in VS Code if you prefer to launch the currently open file directly, but the "Attach" method is generally recommended for debugging the main CLI entry point. +Alternatively, you can use the "Launch Program" configuration in VS Code if you prefer to launch the currently open file directly, but 'F5' is generally recommended. To hit a breakpoint inside the sandbox container run: |