Best practices for GitLab Duo Workflow

Follow these best practices to get the most value from GitLab Duo Workflow.

Create focused prompts

A prompt is the text input that you give to Workflow. To create an effective prompt:

  • Define a clear goal with measurable outcomes.
  • Provide clear context by including relevant files, merge requests, or issues. For information about the types of context Workflow understands, see context.
  • Provide examples of expected changes.
  • Include or link to any technical requirements or rules.

Example prompt:

Scan all Vue.js components in the 'src/components' directory. Add appropriate ARIA attributes
to improve accessibility. Focus on buttons, forms, and navigation elements.
Ensure changes maintain existing functionality.

Review the plan

After you enter your prompt, Workflow generates a plan containing tasks. You can pause and restart Workflow as it creates and works through its plan.

During this process:

  • Confirm all target files are correctly identified.
  • Verify proposed changes align with requirements.
  • Check for any missing dependencies or integration points.
  • Pause the workflow and adjust if needed.

Check proposed changes

As Workflow works through its plan, it stages corresponding changes to the files in your project. The changes might include new or modified files.

Before committing the changes:

  1. Check that Workflow:

    • Targeted the correct files.
    • Made appropriate changes.
    • Followed the requirements and rules from your prompt.

  2. Look for patterns in what it’s missing or misinterpreting. Use that data to refine your prompt. Common errors include:

    • The incorrect solution. We are continuing to work on the accuracy of overall generated content. However, Workflow might generate suggestions that are:
      • Irrelevant.
      • Incomplete.
      • Results in failed pipelines.
      • Potentially insecure.
      • Offensive or insensitive.
    • Adds code in the wrong location.
    • Includes code changes that can’t be used by other parts of the system.

Iterate and improve

When Workflow does not produce the expected results:

  • Document the specific areas that need improvement.
  • Break complex goals into smaller workflows.
  • Add examples of correct and incorrect implementations.
  • Refine prompts to address gaps.

For example, refine your prompts from the general to the specific:

General:

Add ARIA attributes to improve accessibility.

Specific:

Add aria-label attributes to buttons without text content.
Use the button's function for the label value.
Required format: aria-label="Action description"