Overview

Tusk allows you to provide custom instructions to the testing agent to meet your testing guidelines on a per repo basis.

Although Tusk explores your codebase to adhere to your best practices, providing customization ensures Tusk is aware of specific symbols to test, preferred testing patterns, etc.

How to Customize

  1. After your testing agent is set up, you will see a Customization tab in Settings.

  2. Click on the Customization tab.

  1. Select the repo for which you want to modify custom instructions by using the Repo field in the top right corner.

  2. On the left, select the testing environment you want to customize.

  3. You will see a list of fields that you can customize below.

    • Symbol selection guidelines: Types of symbols (i.e., functions, methods) that should or should NOT be tested.
    • Test code guidelines: Best practices for writing tests, creating mocks, using factories, importing dependencies, etc.
    • Edge case guidelines: Notes on the types of edge cases to focus on finding
    • Test location guidelines: Naming conventions for test files and where they should be placed in the repo
  4. Click the Save button after editing each section.

  5. Tusk will now use these custom instructions to generate tests for the repo.

Editors support markdown formatting and ”@” mentions for file references.

Common Customization Examples

Use these examples as starting points. Copy, paste, and adapt them in the Customization tab.

If you have docs, .cursor/rules, or CLAUDE.md files, you can ”@” mention relevant files in the customization.

Symbol Selection Guidelines

By default, Tusk selects the most relevant symbols in your PR/MR to test. Influence this by customizing which symbols to test.

Test Code Guidelines

By default, Tusk finds relevant test files in your codebase and uses them as context when generating tests. Providing customization on how you setup/teardown tests, specific test patterns, etc. will help improve the quality and latency of Tusk’s test generation.

Edge Case Guidelines

By default, Tusk will find relevant test cases by looking at business context, usage of the symbol, and the symbol’s dependencies. Customization will help Tusk focus on the most important edge cases for your repository.

Test Location Guidelines

By default, Tusk looks at the existing test files in your codebase to determine the best location for new test files.