Skip to content

Fix text guidance inconsistencies for issue comment workflows#890

Merged
strawgate merged 2 commits intomainfrom
fix/issue-889-text-improvements-3c825d85f1461e17
Apr 14, 2026
Merged

Fix text guidance inconsistencies for issue comment workflows#890
strawgate merged 2 commits intomainfrom
fix/issue-889-text-improvements-3c825d85f1461e17

Conversation

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions github-actions bot commented Apr 7, 2026

Summary

This updates the three user-facing text issues from #889:

  1. docs/workflows/gh-agent-workflows/create-comment-on-issue.md
    • Replaced "issue reaction trigger" with "issue comment trigger"
    • Replaced "via /ai reaction" with "via an /ai comment"
  2. SECURITY.md
    • Updated trigger wording to clarify that GitHub Agent Workflows use workflow-specific slash commands (examples: /ai, /plan, /docs-review, /gemini, /research) rather than a single global /ai
  3. Makefile
    • Updated make help guidance to point to gh-agent-workflows/*/example.yml templates instead of gh-agent-workflows/*.md

Validation

  • make help
  • make docs-build (fails in strict mode due to pre-existing unrelated doc warnings about missing docs/workflows/detector-fixer-chaining.md links in other pages)

Closes #889


What is this? | From workflow: Trigger Text Auditor

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

github-actions bot and others added 2 commits April 7, 2026 13:57
Clarify comment-vs-reaction wording, document variable slash commands in SECURITY, and point Makefile help to gh-agent workflow template files.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@github-actions github-actions bot added the small_boom Small PR blast radius; usually low human-review need label Apr 7, 2026
@strawgate strawgate marked this pull request as ready for review April 14, 2026 17:14
@strawgate strawgate merged commit 00d758d into main Apr 14, 2026
26 of 27 checks passed
@strawgate strawgate deleted the fix/issue-889-text-improvements-3c825d85f1461e17 branch April 14, 2026 17:16
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 14, 2026

Caution

Review failed

Pull request was closed or merged during review

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: bd5a1366-b235-4a30-8cb2-24c9c9f1db54

📥 Commits

Reviewing files that changed from the base of the PR and between 17f7a24 and 87660ee.

📒 Files selected for processing (3)
  • Makefile
  • SECURITY.md
  • docs/workflows/gh-agent-workflows/create-comment-on-issue.md

📝 Walkthrough

Walkthrough

Three documentation files were updated to correct misleading wording. The Makefile help text now points to gh-agent-workflows/*/example.yml workflow templates instead of gh-agent-workflows/*.md documentation files. SECURITY.md was revised to clarify that GitHub Agent Workflows support multiple slash command triggers (/ai, /plan, /docs-review, /gemini, /research) rather than implying a single /ai keyword. The create-comment-on-issue documentation was updated to replace incorrect "reaction trigger" terminology with "comment trigger," as slash commands are parsed from comment text, not reactions.

🚥 Pre-merge checks | ✅ 2
✅ Passed checks (2 passed)
Check name Status Explanation
Linked Issues check ✅ Passed PR successfully addresses all three objectives from issue #889: corrects reaction→comment terminology in create-comment-on-issue.md, updates SECURITY.md to specify variable slash commands by workflow, and fixes Makefile help to reference gh-agent-workflows/*/example.yml templates.
Out of Scope Changes check ✅ Passed All changes are directly scoped to issue #889 objectives: three files modified with text-only updates to user-facing guidance. No code logic, infrastructure, or unrelated functionality changes detected.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/issue-889-text-improvements-3c825d85f1461e17
  • 🛠️ Update Documentation: Commit on current branch
  • 🛠️ Update Documentation: Create PR

Comment @coderabbitai help to get the list of available commands and usage tips.

strawgate added a commit that referenced this pull request Apr 14, 2026
Recompiles lock files to reflect merged changes from PRs:
#903, #901, #890, #885, #881, #866, #856, #814, #715

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

small_boom Small PR blast radius; usually low human-review need

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[text-auditor] Fix misleading trigger wording and Makefile user guidance text

1 participant