Prompting Genie

Genie is your AI-powered software engineer, ready to assist with tasks ranging from bug fixes to feature implementations. To get the most out of Genie, it's helpful to understand how to communicate effectively with it.

Best Practices for Prompting

While Genie is designed to understand and process a wide range of instructions, providing clear and concise prompts can enhance its effectiveness. Here are some tips:

Be Specific: Clearly state what you want Genie to do. For example, instead of saying "fix the issue," specify "resolve the null pointer exception in UserService.java."
Provide Context: If the task involves specific files or functions, mention them. This helps Genie focus on the relevant parts of your codebase.
Use Step-by-Step Instructions: For complex tasks, breaking them down into smaller steps can make it easier for Genie to process and execute them.
Iterate as Needed: Don't hesitate to refine your prompts based on Genie's responses. Collaboration leads to better outcomes.

Genie's Capabilities

Genie comes equipped with a suite of tools to assist you:

File Reading: Genie can read and analyze files in your repository.
File Search: Search for specific files or content within your codebase.
Keyword Search: Find occurrences of specific keywords across your project.
Directory Navigation: Navigate through your project's directory structure to locate files and folders.
URL Reading: Fetch and process content from specified URLs.
Web Search: Perform web searches to gather information or resources.
Code Execution: Run code snippets to test functionality or validate changes.

You can guide Genie by suggesting which tools might be most helpful for a given task.

Linking Files and Tickets

To provide Genie with additional context:

Attach Files: Use the file explorer to select and attach relevant files to your prompt.
Link Tickets: Associate tasks with existing tickets or issues to give Genie a clearer understanding of the objectives.

Utilizing Workflows

Genie can monitor and interact with your CI workflows:

Workflow Monitoring: Configure Genie to watch specific CI steps, such as tests or linters.
Automated Iteration: If a workflow step fails, Genie can analyze the logs, make necessary code changes, and re-run the workflow until it passes.

To set this up, navigate to your project's settings and specify which CI steps Genie should monitor.

By following these guidelines and leveraging Genie's capabilities, you can streamline your development process and focus on building great software.

PreviousUsing Genie NextCI/CD Integration

Last updated 23 days ago

Was this helpful?

Best Practices for Prompting

While Genie is designed to understand and process a wide range of instructions, providing clear and concise prompts can enhance its effectiveness. Here are some tips:

Be Specific: Clearly state what you want Genie to do. For example, instead of saying "fix the issue," specify "resolve the null pointer exception in UserService.java."

Provide Context: If the task involves specific files or functions, mention them. This helps Genie focus on the relevant parts of your codebase.

Use Step-by-Step Instructions: For complex tasks, breaking them down into smaller steps can make it easier for Genie to process and execute them.

Iterate as Needed: Don't hesitate to refine your prompts based on Genie's responses. Collaboration leads to better outcomes.

Genie's Capabilities

Genie comes equipped with a suite of tools to assist you:

File Reading: Genie can read and analyze files in your repository.

File Search: Search for specific files or content within your codebase.

Keyword Search: Find occurrences of specific keywords across your project.

Directory Navigation: Navigate through your project's directory structure to locate files and folders.

URL Reading: Fetch and process content from specified URLs.

Web Search: Perform web searches to gather information or resources.

Code Execution: Run code snippets to test functionality or validate changes.

You can guide Genie by suggesting which tools might be most helpful for a given task.

Utilizing Workflows

Genie can monitor and interact with your CI workflows:

Workflow Monitoring: Configure Genie to watch specific CI steps, such as tests or linters.

Automated Iteration: If a workflow step fails, Genie can analyze the logs, make necessary code changes, and re-run the workflow until it passes.

To set this up, navigate to your project's settings and specify which CI steps Genie should monitor.

By following these guidelines and leveraging Genie's capabilities, you can streamline your development process and focus on building great software.