feature-296-bugbot-autofix: Implement logic to recommend steps or provide help on newly opened issues based on labels, enhancing issue handling capabilities.

efraespada · efraespada · commit 62d4398d1748 · 2026-02-12T02:43:57.000+01:00
diff --git a/.cursor/rules/architecture.mdc b/.cursor/rules/architecture.mdc
@@ -24,7 +24,7 @@ alwaysApply: true
 | Shared flow | `src/actions/common_action.ts` | mainRun, waitForPreviousRuns, dispatch to use cases |
 | Use cases | `src/usecase/` | issue_use_case, pull_request_use_case, commit_use_case, single_action_use_case |
 | Single actions | `src/usecase/actions/` | check_progress, detect_errors, recommend_steps, think, initial_setup, create_release, create_tag, publish_github_action, deployed_action |
-| Steps (issue) | `src/usecase/steps/issue/` | check_permissions, close_not_allowed_issue, assign_members, update_title, update_issue_type, link_issue_project, check_priority_issue_size, prepare_branches, remove_issue_branches, remove_not_needed_branches, label_deploy_added, label_deployed_added, move_issue_to_in_progress |
+| Steps (issue) | `src/usecase/steps/issue/` | check_permissions, close_not_allowed_issue, assign_members, update_title, update_issue_type, link_issue_project, check_priority_issue_size, prepare_branches, remove_issue_branches, remove_not_needed_branches, label_deploy_added, label_deployed_added, move_issue_to_in_progress, answer_issue_help_use_case (question/help on open). On issue opened: RecommendStepsUseCase (non release/question/help) or AnswerIssueHelpUseCase (question/help). |
 | Steps (PR) | `src/usecase/steps/pull_request/` | update_title, assign_members (issue), assign_reviewers_to_issue, link_pr_project, link_pr_issue, sync_size_and_progress_from_issue, check_priority_pull_request_size, update_description (AI), close_issue_after_merging |
 | Steps (commit) | `src/usecase/steps/commit/` | notify commit, check size |
 | Steps (issue comment) | `src/usecase/steps/issue_comment/` | check_issue_comment_language (translation) |
diff --git a/build/cli/index.js b/build/cli/index.js
diff --git a/build/cli/src/usecase/steps/issue/__tests__/answer_issue_help_use_case.test.d.ts b/build/cli/src/usecase/steps/issue/__tests__/answer_issue_help_use_case.test.d.ts
@@ -0,0 +1 @@
+export {};
diff --git a/build/cli/src/usecase/steps/issue/answer_issue_help_use_case.d.ts b/build/cli/src/usecase/steps/issue/answer_issue_help_use_case.d.ts
@@ -0,0 +1,14 @@
+/**
+ * When a question or help issue is newly opened, posts an initial helpful reply
+ * based on the issue description (OpenCode Plan agent). The user can still
+ * @mention the bot later for follow-up answers (ThinkUseCase).
+ */
+import { Execution } from '../../../data/model/execution';
+import { Result } from '../../../data/model/result';
+import { ParamUseCase } from '../../base/param_usecase';
+export declare class AnswerIssueHelpUseCase implements ParamUseCase<Execution, Result[]> {
+    taskId: string;
+    private aiRepository;
+    private issueRepository;
+    invoke(param: Execution): Promise<Result[]>;
+}
diff --git a/build/cli/src/utils/opencode_project_context_instruction.d.ts b/build/cli/src/utils/opencode_project_context_instruction.d.ts
@@ -0,0 +1,6 @@
+/**
+ * Shared instruction for every prompt we send to OpenCode about the project.
+ * Tells the agent to read not only the code (respecting ignore patterns) but also
+ * the repository documentation and defined rules, for a full picture and better decisions.
+ */
+export declare const OPENCODE_PROJECT_CONTEXT_INSTRUCTION = "**Important \u2013 use full project context:** In addition to reading the relevant code (respecting any file ignore patterns specified), read the repository documentation (e.g. README, docs/) and any defined rules or conventions (e.g. .cursor/rules, CONTRIBUTING, project guidelines). This gives you a complete picture of the project and leads to better decisions in both quality of reasoning and efficiency.";
diff --git a/build/github_action/index.js b/build/github_action/index.js
diff --git a/build/github_action/src/usecase/steps/issue/__tests__/answer_issue_help_use_case.test.d.ts b/build/github_action/src/usecase/steps/issue/__tests__/answer_issue_help_use_case.test.d.ts
@@ -0,0 +1 @@
+export {};
diff --git a/build/github_action/src/usecase/steps/issue/answer_issue_help_use_case.d.ts b/build/github_action/src/usecase/steps/issue/answer_issue_help_use_case.d.ts
@@ -0,0 +1,14 @@
+/**
+ * When a question or help issue is newly opened, posts an initial helpful reply
+ * based on the issue description (OpenCode Plan agent). The user can still
+ * @mention the bot later for follow-up answers (ThinkUseCase).
+ */
+import { Execution } from '../../../data/model/execution';
+import { Result } from '../../../data/model/result';
+import { ParamUseCase } from '../../base/param_usecase';
+export declare class AnswerIssueHelpUseCase implements ParamUseCase<Execution, Result[]> {
+    taskId: string;
+    private aiRepository;
+    private issueRepository;
+    invoke(param: Execution): Promise<Result[]>;
+}
diff --git a/build/github_action/src/utils/opencode_project_context_instruction.d.ts b/build/github_action/src/utils/opencode_project_context_instruction.d.ts
@@ -0,0 +1,6 @@
+/**
+ * Shared instruction for every prompt we send to OpenCode about the project.
+ * Tells the agent to read not only the code (respecting ignore patterns) but also
+ * the repository documentation and defined rules, for a full picture and better decisions.
+ */
+export declare const OPENCODE_PROJECT_CONTEXT_INSTRUCTION = "**Important \u2013 use full project context:** In addition to reading the relevant code (respecting any file ignore patterns specified), read the repository documentation (e.g. README, docs/) and any defined rules or conventions (e.g. .cursor/rules, CONTRIBUTING, project guidelines). This gives you a complete picture of the project and leads to better decisions in both quality of reasoning and efficiency.";
diff --git a/src/usecase/actions/recommend_steps_use_case.ts b/src/usecase/actions/recommend_steps_use_case.ts
@@ -69,7 +69,7 @@ ${OPENCODE_PROJECT_CONTEXT_INSTRUCTION}
 **Issue #${issueNumber} description:**
 ${issueDescription}
 
-Provide a numbered list of recommended steps. You can add brief sub-bullets per step if needed.`;
+Provide a numbered list of recommended steps in **markdown** (use headings, lists, code blocks for commands or snippets) so it is easy to read. You can add brief sub-bullets per step if needed.`;
 
             logInfo(`🤖 Recommending steps using OpenCode Plan agent...`);
             const response = await this.aiRepository.askAgent(
diff --git a/src/usecase/issue_use_case.ts b/src/usecase/issue_use_case.ts
@@ -3,8 +3,10 @@ import { Result } from "../data/model/result";
 import { logInfo } from "../utils/logger";
 import { getTaskEmoji } from "../utils/task_emoji";
 import { ParamUseCase } from "./base/param_usecase";
+import { RecommendStepsUseCase } from "./actions/recommend_steps_use_case";
 import { CheckPermissionsUseCase } from "./steps/common/check_permissions_use_case";
 import { UpdateTitleUseCase } from "./steps/common/update_title_use_case";
+import { AnswerIssueHelpUseCase } from "./steps/issue/answer_issue_help_use_case";
 import { AssignMemberToIssueUseCase } from "./steps/issue/assign_members_to_issue_use_case";
 import { CheckPriorityIssueSizeUseCase } from "./steps/issue/check_priority_issue_size_use_case";
 import { CloseNotAllowedIssueUseCase } from "./steps/issue/close_not_allowed_issue_use_case";
@@ -85,6 +87,19 @@ export class IssueUseCase implements ParamUseCase<Execution, Result[]> {
          */
         results.push(...await new DeployedAddedUseCase().invoke(param));
 
+        /**
+         * On newly opened issues: recommend steps (non release/question/help) or post initial help (question/help).
+         */
+        if (param.issue.opened) {
+            const isRelease = param.labels.isRelease;
+            const isQuestionOrHelp = param.labels.isQuestion || param.labels.isHelp;
+            if (!isRelease && !isQuestionOrHelp) {
+                results.push(...(await new RecommendStepsUseCase().invoke(param)));
+            } else if (isQuestionOrHelp) {
+                results.push(...(await new AnswerIssueHelpUseCase().invoke(param)));
+            }
+        }
+
         return results;
     }
 }
diff --git a/src/usecase/steps/common/__tests__/think_use_case.test.ts b/src/usecase/steps/common/__tests__/think_use_case.test.ts
@@ -92,38 +92,48 @@ describe('ThinkUseCase', () => {
     expect(mockAddComment).not.toHaveBeenCalled();
   });
 
-  it('responds without mention when issue has question label', async () => {
-    mockGetDescription.mockResolvedValue(undefined);
-    mockAskAgent.mockResolvedValue({ answer: 'Here is the answer.' });
-    mockAddComment.mockResolvedValue(undefined);
+  it('does not respond without @mention even when issue has question label', async () => {
     const param = baseParam({
       labels: { isQuestion: true, isHelp: false },
       issue: { ...baseParam().issue, commentBody: 'how do I configure the webhook?' },
     });
 
     const results = await useCase.invoke(param);
 
-    expect(mockAskAgent).toHaveBeenCalledTimes(1);
-    expect(mockAskAgent.mock.calls[0][2]).toContain('how do I configure the webhook?');
-    expect(mockAddComment).toHaveBeenCalledWith('o', 'r', 1, 'Here is the answer.', 't');
+    expect(mockAskAgent).not.toHaveBeenCalled();
+    expect(mockAddComment).not.toHaveBeenCalled();
     expect(results[0].success).toBe(true);
-    expect(results[0].executed).toBe(true);
+    expect(results[0].executed).toBe(false);
   });
 
-  it('responds without mention when issue has help label', async () => {
-    mockGetDescription.mockResolvedValue(undefined);
-    mockAskAgent.mockResolvedValue({ answer: 'I can help with that.' });
-    mockAddComment.mockResolvedValue(undefined);
+  it('does not respond without @mention even when issue has help label', async () => {
     const param = baseParam({
       labels: { isQuestion: false, isHelp: true },
       issue: { ...baseParam().issue, commentBody: 'I need help with deployment' },
     });
 
     const results = await useCase.invoke(param);
 
+    expect(mockAskAgent).not.toHaveBeenCalled();
+    expect(mockAddComment).not.toHaveBeenCalled();
+    expect(results[0].success).toBe(true);
+    expect(results[0].executed).toBe(false);
+  });
+
+  it('responds when issue has question label and comment mentions bot', async () => {
+    mockGetDescription.mockResolvedValue(undefined);
+    mockAskAgent.mockResolvedValue({ answer: 'Here is the answer.' });
+    mockAddComment.mockResolvedValue(undefined);
+    const param = baseParam({
+      labels: { isQuestion: true, isHelp: false },
+      issue: { ...baseParam().issue, commentBody: '@bot how do I configure the webhook?' },
+    });
+
+    const results = await useCase.invoke(param);
+
     expect(mockAskAgent).toHaveBeenCalledTimes(1);
-    expect(mockAskAgent.mock.calls[0][2]).toContain('I need help with deployment');
-    expect(mockAddComment).toHaveBeenCalledWith('o', 'r', 1, 'I can help with that.', 't');
+    expect(mockAskAgent.mock.calls[0][2]).toContain('how do I configure the webhook?');
+    expect(mockAddComment).toHaveBeenCalledWith('o', 'r', 1, 'Here is the answer.', 't');
     expect(results[0].success).toBe(true);
     expect(results[0].executed).toBe(true);
   });
diff --git a/src/usecase/steps/common/think_use_case.ts b/src/usecase/steps/common/think_use_case.ts
@@ -33,33 +33,28 @@ export class ThinkUseCase implements ParamUseCase<Execution, Result[]> {
                 return results;
             }
 
-            const isHelpOrQuestionIssue =
-                param.labels.isQuestion || param.labels.isHelp;
-
-            if (!isHelpOrQuestionIssue) {
-                if (!param.tokenUser?.trim()) {
-                    logInfo('Bot username (tokenUser) not set; skipping Think response.');
-                    results.push(
-                        new Result({
-                            id: this.taskId,
-                            success: true,
-                            executed: false,
-                        })
-                    );
-                    return results;
-                }
+            if (!param.tokenUser?.trim()) {
+                logInfo('Bot username (tokenUser) not set; skipping Think response.');
+                results.push(
+                    new Result({
+                        id: this.taskId,
+                        success: true,
+                        executed: false,
+                    })
+                );
+                return results;
+            }
 
-                if (!commentBody.includes(`@${param.tokenUser}`)) {
-                    logInfo(`Comment does not mention @${param.tokenUser}; skipping.`);
-                    results.push(
-                        new Result({
-                            id: this.taskId,
-                            success: true,
-                            executed: false,
-                        })
-                    );
-                    return results;
-                }
+            if (!commentBody.includes(`@${param.tokenUser}`)) {
+                logInfo(`Comment does not mention @${param.tokenUser}; skipping.`);
+                results.push(
+                    new Result({
+                        id: this.taskId,
+                        success: true,
+                        executed: false,
+                    })
+                );
+                return results;
             }
 
             if (!param.ai.getOpencodeModel()?.trim() || !param.ai.getOpencodeServerUrl()?.trim()) {
@@ -74,9 +69,7 @@ export class ThinkUseCase implements ParamUseCase<Execution, Result[]> {
                 return results;
             }
 
-            const question = isHelpOrQuestionIssue
-                ? commentBody.trim()
-                : commentBody.replace(new RegExp(`@${param.tokenUser}`, 'gi'), '').trim();
+            const question = commentBody.replace(new RegExp(`@${param.tokenUser}`, 'gi'), '').trim();
             if (!question) {
                 results.push(
                     new Result({
@@ -106,7 +99,7 @@ export class ThinkUseCase implements ParamUseCase<Execution, Result[]> {
             const contextBlock = issueDescription
                 ? `\n\nContext (issue #${issueNumberForContext} description):\n${issueDescription}\n\n`
                 : '\n\n';
-            const prompt = `You are a helpful assistant. Answer the following question concisely, using the context below when relevant. Do not include the question in your response.
+            const prompt = `You are a helpful assistant. Answer the following question concisely, using the context below when relevant. Format your answer in **markdown** (headings, lists, code blocks where useful) so it is easy to read. Do not include the question in your response.
 
 ${OPENCODE_PROJECT_CONTEXT_INSTRUCTION}
 ${contextBlock}Question: ${question}`;
diff --git a/src/usecase/steps/issue/__tests__/answer_issue_help_use_case.test.ts b/src/usecase/steps/issue/__tests__/answer_issue_help_use_case.test.ts
diff --git a/src/usecase/steps/issue/answer_issue_help_use_case.ts b/src/usecase/steps/issue/answer_issue_help_use_case.ts
