From 1737114b2ad6d2e21e53e56565886dc300363f3c Mon Sep 17 00:00:00 2001 From: openhands Date: Wed, 13 Aug 2025 05:08:20 +0000 Subject: [PATCH] Fix issue #34: Update README to explain one can fix issue using Claude Code github action --- README.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) diff --git a/README.md b/README.md index a09f1e3..93a5685 100644 --- a/README.md +++ b/README.md @@ -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)