Skip to content

Fix issue #34: Update README to explain one can fix issue using Claude Code github action #36

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Fix issue #34: Update README to explain one can fix issue using Claude Code github action #36

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 36 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,42 @@ If you encounter API errors:
2. Check your API rate limits and quotas
3. The app will automatically retry failed requests with exponential backoff


## Fix issues using the Claude Code GitHub Action

This repository includes a ready-to-use workflow that lets you ask Claude to propose fixes via GitHub comments.

How it works
- The workflow is defined at .github/workflows/claude.yml and uses anthropics/claude-code-action@beta
- It listens to the following events when the text contains "@claude":
- New issue body
- Issue comment
- Pull request review comment
- Pull request review submission
- When triggered, Claude analyzes the repository and your request for up to 60 minutes and proposes changes

Prerequisites
- In your GitHub repository settings, add one of the following secrets:
- ANTHROPIC_API_KEY: an Anthropic API key with access to Claude
- OR set CLAUDE_CODE_OAUTH_TOKEN if you are using the OAuth-based setup (see action docs)

How to trigger a fix
1. Open or comment on an issue describing the problem, and mention Claude with clear instructions. For example:
- "@claude update README to explain how to fix issues using the Claude Code GitHub Action"
- "@claude fix failing tests in tests/ and explain the changes"
2. Or, on a pull request, leave a review comment with an @claude mention and what you want fixed
3. Monitor the action run under the Actions tab; it will respond in the thread and/or create a proposed change depending on repository permissions

Tips
- Be specific about the desired outcome and any constraints (e.g., file paths, style, tests)
- If the action doesn’t respond, verify:
- The mention includes exactly "@claude"
- Repository Actions are enabled
- Required secret (ANTHROPIC_API_KEY or CLAUDE_CODE_OAUTH_TOKEN) is present

Security and network access
- The workflow is configured with minimal permissions and supports optional network domain allowlisting. See the commented experimental_allowed_domains section in .github/workflows/claude.yml if you need to restrict outbound requests.

## Notes

- Uses GPT-5 (gpt-5-2025-08-07)
Expand Down
Loading