Skip to content

Consolidate README onboarding into a single deduplicated setup flow#8

Merged
lklimek merged 2 commits into
mainfrom
copilot/refactor-readme-duplicate-info
Mar 7, 2026
Merged

Consolidate README onboarding into a single deduplicated setup flow#8
lklimek merged 2 commits into
mainfrom
copilot/refactor-readme-duplicate-info

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 6, 2026

README onboarding content repeated the same guidance across Installation, Quick Start, and Setting up with your agent, which made setup harder to scan. This change merges those into one concise section while preserving all required operational and safety instructions.

  • Unified onboarding

    • Replaced three overlapping sections with a single Installation and agent setup section.
    • Kept install paths (pipx, pip, source) and setup flow in one place.
  • Deduplicated agent/token guidance

    • Consolidated write token setup (ghsudo --setup <org>), read-only agent token configuration, template file placement (CLAUDE.md / AGENTS.md), and verification commands.
    • Removed repeated explanations and repeated command examples.
  • Preserved critical operational notes

    • Retained HTTPS remote + gh auth setup-git requirement for push/pull with elevated token.
    • Retained dedicated-terminal warning to avoid inheriting writable gh credentials.
    • Retained platform support note and write-operation command examples.
  • Resulting streamlined setup flow

    pipx install ghsudo
    ghsudo --setup <org>
    echo "<your-read-only-token>" | gh auth login --hostname github.com --with-token
    # or: export GH_TOKEN=<your-read-only-token>
    ghsudo --verify <org>
    ghsudo --list

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: lklimek <842586+lklimek@users.noreply.github.com>
Copilot AI changed the title [WIP] Refactor README.md to remove duplicated information Consolidate README onboarding into a single deduplicated setup flow Mar 6, 2026
@lklimek lklimek marked this pull request as ready for review March 7, 2026 07:28
Copilot AI review requested due to automatic review settings March 7, 2026 07:28
@lklimek lklimek merged commit 546be42 into main Mar 7, 2026
6 checks passed
@lklimek lklimek deleted the copilot/refactor-readme-duplicate-info branch March 7, 2026 07:28
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR streamlines the README onboarding flow by consolidating overlapping installation, quick start, and agent setup guidance into a single “Installation and agent setup” section, aiming to make setup easier to scan while retaining key safety/operational notes.

Changes:

  • Replaced separate Installation / Quick Start / Agent setup sections with a unified onboarding section.
  • Deduplicated token setup + agent instructions guidance and centralized verification commands.
  • Preserved key operational notes (HTTPS remotes for git push/pull, gh auth setup-git, dedicated terminal warning, platform support).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines +60 to +74
2. Configure your coding agent to use a separate read-only token:
```bash
echo "<your-read-only-token>" | gh auth login --hostname github.com --with-token
# or (session-scoped): export GH_TOKEN=<your-read-only-token>
```
3. Add agent instructions in each target repository:
- Claude Code: copy [`CLAUDE-example.md`](CLAUDE-example.md) to `CLAUDE.md`
- OpenAI Codex: copy [`AGENTS-example.md`](AGENTS-example.md) to `AGENTS.md`
4. Verify:
```bash
ghsudo --verify <org>
ghsudo --list
```

> **⚠️ Important:** Run the agent in a dedicated terminal/subshell where `gh` is authenticated with the read-only token. Otherwise the agent may inherit your writable `gh` credentials and bypass `ghsudo`.
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The recommended read-only setup uses gh auth login, but that authentication is persisted in gh’s global config (it’s not limited to a single terminal). The current “dedicated terminal/subshell” warning reads like terminal isolation is sufficient, which isn’t true unless you instead use GH_TOKEN/GITHUB_TOKEN env vars or a separate GH_CONFIG_DIR for the agent. Consider clarifying the persistence/restore steps (or recommending env-var / separate config dir for agent sessions) so users don’t accidentally overwrite their normal gh login or get a false sense of isolation.

Copilot uses AI. Check for mistakes.
Comment thread README.md
Comment on lines +60 to +67
2. Configure your coding agent to use a separate read-only token:
```bash
echo "<your-read-only-token>" | gh auth login --hostname github.com --with-token
# or (session-scoped): export GH_TOKEN=<your-read-only-token>
```
3. Add agent instructions in each target repository:
- Claude Code: copy [`CLAUDE-example.md`](CLAUDE-example.md) to `CLAUDE.md`
- OpenAI Codex: copy [`AGENTS-example.md`](AGENTS-example.md) to `AGENTS.md`
Copy link

Copilot AI Mar 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The instructions point users to copy CLAUDE-example.md / AGENTS-example.md, but those templates currently state the agent has a read-only GH_TOKEN. Since this section also recommends gh auth login (which doesn’t set GH_TOKEN), this can be confusing. Consider adjusting the README wording here to say the agent may be configured via GH_TOKEN/GITHUB_TOKEN or gh auth login, and that the templates’ “GH_TOKEN” wording is shorthand for the read-only gh authentication context.

Suggested change
2. Configure your coding agent to use a separate read-only token:
```bash
echo "<your-read-only-token>" | gh auth login --hostname github.com --with-token
# or (session-scoped): export GH_TOKEN=<your-read-only-token>
```
3. Add agent instructions in each target repository:
- Claude Code: copy [`CLAUDE-example.md`](CLAUDE-example.md) to `CLAUDE.md`
- OpenAI Codex: copy [`AGENTS-example.md`](AGENTS-example.md) to `AGENTS.md`
2. Configure your coding agent to use a separate read-only token (either via `gh auth login` or an environment variable):
```bash
# Option A: configure `gh` with a read-only token (preferred)
echo "<your-read-only-token>" | gh auth login --hostname github.com --with-token
#
# Option B: session-scoped environment variable for tools that read GH_TOKEN/GITHUB_TOKEN directly
export GH_TOKEN=<your-read-only-token> # or: export GITHUB_TOKEN=<your-read-only-token>
  1. Add agent instructions in each target repository:

    In these templates, references to GH_TOKEN mean the agent's read-only GitHub authentication context. You can provide this either by exporting GH_TOKEN/GITHUB_TOKEN or by authenticating gh with gh auth login using the read-only token above.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants