jacob-ai-bot / jacob

Just Another Coding Bot
https://jacb.ai
Apache License 2.0
131 stars 20 forks source link

JACoB PR for Issue Implement "Project Level Research" Feature for Onboarding New Projects #350

Closed jacob-ai-bot[bot] closed 6 days ago

jacob-ai-bot[bot] commented 1 week ago

Summary:

Description

Enhance the onboarding process in JACoB by adding a new "Project Level Research" feature. When a new project is onboarded, the system should automatically generate detailed research questions and answers that address fundamental information about the codebase. This will help users gain a deeper understanding of the project they are working on.

Tasks

  1. Update research.ts in the Agent Folder

    • In the /src/server/agent/research.ts file, add an exported function.

    • This function should:

      • Accept a source map and an array of codebase context items as parameters.
      • Iterate over each question in researchQuestions.
      • Call the researchCodebase function for each question.
    • In the new function within research.ts, instead of referencing a specific GitHub issue, include hardcoded sentences to prompt the research. For example:

      "To assist the user in understanding the codebase, please conduct thorough research and provide detailed insights."

    • Refine the phrasing to be professional and clear.

Expected Outcome

Notes

Plan:

Step 1: Edit /src/server/agent/research.ts

Task: Add Project Level Research Function to research.ts

Instructions: In the /src/server/agent/research.ts file, create a new exported asynchronous function named researchProject. This function should accept two parameters: a sourceMap (string) and an array of codebaseContext items. Inside the function, import an array from /src/data/researchQuestions.ts called researchQuestions, an array of strings containing professionally phrased, hardcoded questions that will prompt detailed research and insights about the codebase (e.g., 'Provide an overview of the main functionalities of the codebase.'). Iterate over each question in researchQuestions, and for each question, call the researchCodebase function, passing the question and the necessary parameters (sourceMap and codebaseContext). Ensure that the function does not reference any specific GitHub issue, as it is intended for general project-level research during onboarding.

Exit Criteria: The researchProject function is correctly implemented, accepts the required parameters, utilizes the researchQuestions array to iterate over questions, calls researchCodebase for each question, and generates research answers without referencing a specific GitHub issue.

jacob-ai-bot[bot] commented 1 week ago

Hello human! 👋

This PR was created by JACoB to address the issue Implement "Project Level Research" Feature for Onboarding New Projects

Next Steps

  1. Please review the PR carefully. Auto-generated code can and will contain subtle bugs and mistakes.

  2. If you identify code that needs to be changed, please reject the PR with a specific reason. Be as detailed as possible in your comments. JACoB will take these comments, make changes to the code and push up changes. Please note that this process will take a few minutes.

  3. Once the code looks good, approve the PR and merge the code.