Skip to content

Issue 3: Code Review & Pull Request Workflows #96

Description

@jjsilva4

Task Overview

Audit documentation covering Pull Requests, Code Review, and Branch Statuses to reflect the integration with GitKraken Code Review (gitkraken.dev) and Merged PR indicators released between v12.1.0 and v12.4.0.

Background & Updates to Incorporate

  • Web-Based Code Review on gitkraken.dev (v12.1.0, v12.3.0):

    • In-app PR review routes users to GitKraken Code Review at gitkraken.dev/review.
    • Features: Advanced diff viewer visualizing moved code, AI-generated pull request overviews and suggestions, interactive chat for asking code questions, file mark-as-reviewed toggles, and reviewer management. Launchable from Launchpad, Left Panel PRs, or Graph context menus.
  • Merged PR Pills & Direct Workspace Cleanup (v12.1.2, v12.2.1, v12.4.0):

    • Merged PR status badges appear on the Toolbar, Commit Details panel, and worktree cards for GitHub PRs and GitLab MRs.
    • Users can clean up shipped work directly by deleting worktrees and associated local/remote branches straight from agent panel cards.

Google Technical Writing & Help Center Standards

When modifying or writing content, enforce the following:

  • Terminology Consistency: Use terms consistently (e.g., do not interchange "GitKraken Code Review", "gitkraken.dev", and "Web PR Review" ambiguously).
  • Avoid Ambiguous Pronouns: Ensure pronouns (this, that, it, they) clearly reference a specific noun.
  • Lists: Keep list items grammatically parallel (all complete sentences or all verb phrases).
  • Accessibility: Ensure callouts and status indicators do not rely on color alone to convey meaning (pair color with text labels or symbols).
  • Media Tagging: Wrap screenshots in HTML <figure> elements with class="help-center-img img-bordered" and centered #888 captions.

Acceptance Criteria for Claude Code

  • Audit files under /pull-requests, /code-review, and /gitkraken-dev.
  • Update PR review documentation to direct users to gitkraken.dev/review.
  • List AI features within GitKraken Code Review (diff overviews, suggestions, chat).
  • Document Merged PR status pills and direct workspace cleanup from agent cards.
  • Verify document adheres strictly to Google Technical Writing standards.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions