jcarr
/
gemini-cli
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md (#1130)

This commit is contained in:
matt korwel 2025-06-17 00:09:23 -07:00 committed by GitHub
parent 137baa0a07
commit bc3fa71234
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 6 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
CONTRIBUTING.md
View File

@ -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`). 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 ## Development Setup and Workflow
This section guides contributors on how to build, modify, and understand the development setup of this project. 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: ### 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: 1. Start the CLI in debug mode from the root directory:
```bash ```bash
npm run debug 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. 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`). 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: To hit a breakpoint inside the sandbox container run: