Skip to content

Commit 040d301

Browse files
authored
Update Repo Assist instructions for clarity
Clarified the behavior of Repo Assist when triggered with instructions.
1 parent f2c5cf1 commit 040d301

1 file changed

Lines changed: 6 additions & 1 deletion

File tree

docs/repo-assist.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,14 +128,19 @@ You can also trigger Repo Assist on-demand by commenting on any issue or PR:
128128
/repo-assist <instructions>
129129
```
130130

131-
When triggered this way, Repo Assist focuses exclusively on your instructions instead of running its normal scheduled tasks. For example:
131+
When triggered this way, Repo Assist starts a new coding agent session immediately and focuses exclusively on your instructions instead of running its normal scheduled tasks. For example:
132132

133133
- `/repo-assist investigate this bug and suggest a fix`
134134
- `/repo-assist add documentation for the new API endpoints`
135135
- `/repo-assist review this PR and suggest improvements`
136136

137137
All the same guidelines apply (AI disclosure, running formatters/linters/tests, being polite and constructive).
138138

139+
> NOTE: There are a few glitches with "/repo-assist" direct commands (which are meant to start a contextualised agent coding run directly)
140+
> - It doesn't work from code review comments
141+
> - "/repo-assist" has to be first thing in comment
142+
> - No link to the run is given
143+
139144
### Triggering CI on Pull Requests
140145

141146
To automatically trigger CI checks on PRs created by this workflow, configure an additional repository secret `GH_AW_CI_TRIGGER_TOKEN`. See the [triggering CI documentation](https://github.github.com/gh-aw/reference/triggering-ci/) for setup instructions.

0 commit comments

Comments
 (0)