Skip to content

Comments

feat: improve examples and migration guide with GitHub context#505

Merged
km-anthropic merged 4 commits intomainfrom
docs/improve-examples-and-migration-guidance
Aug 29, 2025
Merged

feat: improve examples and migration guide with GitHub context#505
km-anthropic merged 4 commits intomainfrom
docs/improve-examples-and-migration-guidance

Conversation

@km-anthropic
Copy link
Collaborator

Fixes issues reported in discussions #490 and #491.

Changes

  • **Add ** - 9 complete use case examples with working configurations
  • Fix migration guide - Examples now include required GitHub context (REPO, PR NUMBER)
  • Update examples - Added missing context to workflow-dispatch-agent and claude-modes
  • Enhance README - Added Solutions & Use Cases section for better discoverability
  • Document changes - Explain tracking comment removal in automation mode

All PR review examples now include proper GitHub context to prevent reviews of wrong repositories.

- Add comprehensive solutions.md with 9 complete use case examples
- Fix migration guide examples to include required GitHub context
- Update examples missing GitHub context (workflow-dispatch-agent, claude-modes)
- Enhance README with prominent Solutions & Use Cases section
- Document tracking comment behavior change in automation mode
- All PR review examples now include REPO and PR NUMBER context

Fixes issues reported in discussions #490 and #491 where:
- Migration examples were dysfunctional without GitHub context
- Users lost PR review capability after v0.x migration
- Missing explanation of tracking comment removal in agent mode

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@km-anthropic
Copy link
Collaborator Author

@claude run bun format pls to fix the ci and commit your changes

@claude
Copy link
Contributor

claude bot commented Aug 28, 2025

Claude finished @km-anthropic's task —— View job


Running formatter to fix CI

  • Check current git status and CI issues
  • Run bun run format to fix formatting
  • Manual formatting required due to approval restrictions

Status Update

I cannot run the formatting commands (bun run format or prettier --write .) directly as they require approval in this environment for security reasons.

The git working tree is currently clean, which suggests the formatting issues may be in the CI environment or the formatter needs to be run to fix them.

Next Steps:

  1. Please run bun run format locally or in the CI environment
  2. If files are modified, commit them with:
    git add .
    git commit -m "fix: apply prettier formatting to resolve CI issues
    
    Co-authored-by: kashyap murali <km-anthropic@users.noreply.github.com>"
    git push

Alternatively, if you have the appropriate tool permissions configured, you can re-trigger this action with expanded --allowedTools to include formatting commands.

@claude
Copy link
Contributor

claude bot commented Aug 28, 2025

Claude finished @km-anthropic's task —— View job


Tasks

  • Run bun format to fix formatting issues
  • Review formatting changes
  • Commit and push the changes

Done! I've successfully formatted the code with prettier and pushed the changes to fix the CI. The formatter fixed formatting issues in 6 files:

  • README.md
  • docs/migration-guide.md
  • docs/solutions.md
  • docs/usage.md
  • examples/claude-modes.yml
  • examples/workflow-dispatch-agent.yml

The changes have been committed and pushed to the PR branch.

Co-authored-by: kashyap murali <km-anthropic@users.noreply.github.com>
@km-anthropic km-anthropic marked this pull request as ready for review August 29, 2025 19:20
Copy link
Collaborator

Choose a reason for hiding this comment

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

Let's rename this to something clearer? Modes aren't part of the public interface.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Also, I can't comment on line 26 but we should update it to @v1

Copy link
Collaborator

Choose a reason for hiding this comment

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

v1 here too

- Remove 5 redundant examples (57% reduction: 12→7 files)
  - Deleted: claude.yml, claude-auto-review.yml, claude-modes.yml,
    claude-args-example.yml, auto-fix-ci-signed/
- Rename examples for clarity
  - pr-review-with-tracking.yml → pr-review-comprehensive.yml
  - claude-pr-path-specific.yml → pr-review-filtered-paths.yml
  - claude-review-from-author.yml → pr-review-filtered-authors.yml
  - workflow-dispatch-agent.yml → manual-code-analysis.yml
  - auto-fix-ci/auto-fix-ci.yml → ci-failure-auto-fix.yml
- Update all examples from @V1-Dev to @v1
- Remove implementation details (agent mode references) from docs
- Delete obsolete DIY Progress Tracking section
- Add track_progress documentation and examples

Addresses PR feedback about exposing internal implementation details
and consolidates redundant examples into focused, clear use cases.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@km-anthropic
Copy link
Collaborator Author

@claude run bun format pls

@claude
Copy link
Contributor

claude bot commented Aug 29, 2025

Claude finished @km-anthropic's task —— View job


Running bun format to fix CI

  • Check current git status
  • Run bun run format command (Requires approval)
  • Check for formatting changes
  • Commit and push changes if needed

Status Update

I cannot run the formatting commands (bun run format or prettier --write .) directly as they require approval in this environment for security reasons.

The git working tree is currently clean, which suggests the formatting issues may be in the CI environment or need to be resolved by running the formatter.

Next Steps:

  1. Local approach: Run bun run format locally on your machine, then commit and push any changes
  2. CI approach: The formatting issue might resolve itself on the next CI run
  3. Permission approach: Re-trigger this action with expanded --allowedTools to include formatting commands

If running locally:

bun run format
git add .
git commit -m "fix: apply prettier formatting to resolve CI issues

Co-authored-by: kashyap murali <km-anthropic@users.noreply.github.com>"
git push

@claude
Copy link
Contributor

claude bot commented Aug 29, 2025

Claude finished @km-anthropic's task —— View job


✅ Formatter completed successfully

  • Check current git status
  • Run bun run format to fix formatting
  • Review formatting changes
  • Commit and push changes

Summary: Successfully ran bun run format and fixed formatting issues in 3 files:

  • docs/migration-guide.md - Fixed trailing spaces and newlines
  • docs/solutions.md - Fixed trailing spaces and newlines
  • examples/pr-review-comprehensive.yml - Fixed trailing spaces and newlines

The changes have been committed and pushed to the PR branch to fix the CI formatting issues.

@km-anthropic
Copy link
Collaborator Author

@ashwin-ant cleared out some older .ymls instead, and updated the remaining ones.

Applied prettier formatting to 3 files to resolve CI formatting issues.

Co-authored-by: kashyap murali <km-anthropic@users.noreply.github.com>
@km-anthropic km-anthropic merged commit 3ed1448 into main Aug 29, 2025
14 checks passed
@km-anthropic km-anthropic deleted the docs/improve-examples-and-migration-guidance branch August 29, 2025 23:55
km-anthropic added a commit that referenced this pull request Aug 30, 2025
PR #505 removed claude.yml as part of simplifying examples, but this
left a gap - there was no longer a generic tag mode example showing
how to respond to @claude mentions.

This file serves as the primary starting point for users wanting to
use tag mode to have Claude respond to mentions in:
- Issue comments
- Pull request review comments
- Issues (when opened or assigned)
- Pull request reviews

The example includes all required permissions and shows optional
configurations commented out.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
km-anthropic added a commit that referenced this pull request Aug 30, 2025
PR #505 removed claude.yml as part of simplifying examples, but this
left a gap - there was no longer a generic tag mode example showing
how to respond to @claude mentions.

This file serves as the primary starting point for users wanting to
use tag mode to have Claude respond to mentions in:
- Issue comments
- Pull request review comments
- Issues (when opened or assigned)
- Pull request reviews

The example includes all required permissions and shows optional
configurations commented out.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
ashwin-ant pushed a commit that referenced this pull request Sep 2, 2025
* restore: bring back generic tag mode example (claude.yml)

PR #505 removed claude.yml as part of simplifying examples, but this
left a gap - there was no longer a generic tag mode example showing
how to respond to @claude mentions.

This file serves as the primary starting point for users wanting to
use tag mode to have Claude respond to mentions in:
- Issue comments
- Pull request review comments
- Issues (when opened or assigned)
- Pull request reviews

The example includes all required permissions and shows optional
configurations commented out.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>

* format: add missing newline at end of claude.yml

Co-authored-by: kashyap murali <km-anthropic@users.noreply.github.com>

---------

Co-authored-by: Claude <noreply@anthropic.com>
Co-authored-by: claude[bot] <209825114+claude[bot]@users.noreply.github.com>
Co-authored-by: kashyap murali <km-anthropic@users.noreply.github.com>
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