Learn how to customize Droid behavior using the .droid.yaml file
.droid.yaml
file at the root of your project allows you to customize Droid behavior through a simple YAML configuration. This powerful tool enables you to tailor Factory’s AI-driven assistance to your specific needs.
.droid.yaml
structure:
review
section configures how Droid performs code reviews.
path
: An fnmatch pattern specifying which files the guideline applies to.guideline
: The specific instruction for Droid to follow during reviews.enabled
: Enable automatic code review on pull request open (default: false).draft
: Enable automatic code review on draft pull requests (default: false).bot
: Enable automatic code review on pull requests authored by bots (default: false).ignore_title_keywords
: Skip review for pull requests with these keywords in the title.ignore_labels
: Skip review for pull requests with these labels.excluded_base_branches
: Skip review for pull requests on these base branches.pr_summary
: Generate a summary of the pull request (default: true).file_summaries
: Generate summaries of modified files (default: true).tips
: Include Droid Tips in the review (default: true).github_action_repair
: Suggest solutions to GitHub Action failures (default: true).path_filters
: Patterns to include/exclude for review. Use cautiously.enable_skip_reason_comments
: Add comments explaining why Droid skipped a review..droid.yaml
when modified in a pull request. Otherwise, use a YAML validation tool to ensure valid YAML syntax.