For the complete documentation index, see llms.txt. This page is also available as Markdown.

Code Health

Follow these steps to get started with the Code Health module -

Step 1: Get Started

Navigate to the Code Health module on your dashboard after onboarding your Git account with Typo. Click the Get Started button.

Step 2: Grant Permissions to Your GitHub Repos

Update the required permissions.

Know more about permissions here

Admin access to your GitHub account is needed to complete this step.

πŸš€ Note: We do not store your code. We only save code snippets where issues are detected to display them and provide auto-fix suggestions.

Step 3: Repo Analysis

Once permissions are granted, your repo will be analyzed. Detected issues will appear on your dashboard based on the configured rules.

How to exclude a file from code review

The Configuration settings allow you to bypass code health reviews for specific files, directories, or Pull Requests. Adjust these fields to streamline your review process.

Exclude Directories

Use this field to prevent the system from reviewing Pull Requests pertaining to specific directories or files. Regular expressions (regex) are not supported. For example, you can enter /migrations/, .spec.ts, Test.py, test/, or .test.json to exclude those specific items from being scanned.

Ignore Title Keywords

Use this field to skip the review entirely if the Pull Request title contains specific, case-sensitive terms. Regular expressions are not supported in this field either. Examples of keywords you might use [Synk] , deploy-stage , backupetc.

Restore Defaults

To clear your current inputs and revert to the original platform configuration, click the Restore Defaults button at the bottom of the page.

How to add a YAML configuration file for Code Health How to Configure Typo Code Health Checks to Block a PR Merge in Git

Last updated