> For the complete documentation index, see [llms.txt](https://typo.gitbook.io/typo-help-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://typo.gitbook.io/typo-help-docs/platform/settings-and-admin/code-health-configuration/code-health.md).

# 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.

<div align="left"><figure><img src="/files/TqaPUQ8j8l52iVC4og5z" alt=""><figcaption></figcaption></figure></div>

### Step 2: Grant Permissions to Your GitHub Repos

Update the required permissions. &#x20;

<div align="left"><figure><img src="/files/ot1ExhWqIiYOY7iKIbf0" alt="" width="563"><figcaption></figcaption></figure></div>

Know more about [permissions here](/typo-help-docs/faqs/data-security-and-privacy/github-app-permissions-details.md)

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

{% hint style="info" %}
🚀 Note: We do not store your code. We only save code snippets where issues are detected to display them and provide auto-fix suggestions.
{% endhint %}

### **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&#x20;

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&#x20;

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` , `backup`etc.

#### Restore Defaults&#x20;

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](/typo-help-docs/faqs/metrics-faq/how-to-add-a-configuration-file-for-code-health.md)\
[How to Configure Typo Code Health Checks to Block a PR Merge in Git](/typo-help-docs/faqs/metrics-faq/how-to-configure-typo-code-health-checks-to-block-a-pr-merge-in-git.md)