Skip to content

Commit 2de42b8

Browse files
committed
docs: clarify prompt options hierarchy in bot automation example
1 parent f266832 commit 2de42b8

File tree

1 file changed

+11
-5
lines changed

1 file changed

+11
-5
lines changed

examples/bot-automation.yml

Lines changed: 11 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,19 @@ jobs:
4444
github_token: ${{ steps.app-token.outputs.token }} # Use App token, not GITHUB_TOKEN
4545
allow_bot_actor: true # Enable bot actors to trigger Claude
4646

47-
# Option 1: direct_prompt - Adds priority instructions to standard prompt
47+
# Option 1: custom_instructions - Adds personality/rules while keeping standard GitHub context
48+
# custom_instructions: |
49+
# You're a friendly but thorough code reviewer.
50+
# Always check for edge cases and suggest tests.
51+
# Be encouraging to new contributors.
52+
53+
# Option 2: direct_prompt - High-priority override instructions
4854
# direct_prompt: |
49-
# Focus on security implications and performance impacts.
50-
# Be extra thorough with database migrations.
51-
# Always suggest tests for new features.
55+
# ONLY review security issues. Ignore style/formatting.
56+
# Do NOT implement any code changes.
57+
# Focus on SQL injection and XSS vulnerabilities.
5258

53-
# Option 2: override_prompt - Completely replaces the standard prompt
59+
# Option 3: override_prompt - Completely replaces the standard prompt (loses GitHub context)
5460
# override_prompt: |
5561
# You are a specialized code reviewer for our API.
5662
# Review the PR focusing only on:

0 commit comments

Comments
 (0)