Skip to content

Improve git-glimpse onboarding with AI agent prompt and tips #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DeDuckProject merged 2 commits into from
Mar 15, 2026
Merged

Improve git-glimpse onboarding with AI agent prompt and tips #51

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7dee984
docs: add one-prompt AI integration snippet and auto-mode tip to quic…
claude Mar 15, 2026
9b8dc95
docs: link to example integration PR in quick start
claude Mar 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,12 @@ PR opened/updated (or /glimpse comment)

## Quick start

> **One-prompt integration:** Paste this into your AI agent (Cursor, Copilot, Claude Code, etc.):
> ```
> Integrate git-glimpse into this repo: https://github.com/DeDuckProject/git-glimpse. Follow the README instructions.
> ```
> See [an example integration PR](https://github.com/DeDuckProject/epp-demo/pull/41) to know what to expect.

### 1. Add the workflow files

Two files are recommended. The first is the main pipeline; the second gives instant 👀 feedback on `/glimpse` comments without adding noise to PR push checks.
Expand Down Expand Up @@ -140,6 +146,8 @@ export default {
} satisfies GitGlimpseConfig;
```

> **Tip:** Keep the default `auto` mode for your first PR — it runs automatically so you'll see the demo right away. Once you've confirmed everything works, you can switch to `on-demand` if you prefer. Starting with `on-demand` means no demo on your first PR, so you won't know if the integration is working.

### 3. Add secrets

In your repo: **Settings → Secrets and variables → Actions**
Expand Down
Loading