> ## Documentation Index
> Fetch the complete documentation index at: https://docs.propelcode.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# .propelignore guide

> Use .propelignore files to exclude files from Propel code review.

Use `.propelignore` files to exclude files from Propel's code review.

## Quick start

Create a `.propelignore` file in your repository root:

```gitignore .propelignore theme={null}
# Exclude test files
**/*.test.ts
**/*.spec.ts

# Exclude generated code
**/*.generated.ts
dist/

# Exclude vendor dependencies
vendor/
node_modules/
```

Files matching these patterns are skipped in Propel code reviews.

## Pattern syntax

`.propelignore` uses the same syntax as `.gitignore`.

| Pattern | Matches |
| - | - |
| `*.log` | All `.log` files |
| `dist/` | The `dist` directory and everything inside |
| `**/*.test.ts` | All `.test.ts` files in any directory |
| `!important.ts` | Re-includes `important.ts` (negation) |
| `# comment` | Comment line (ignored) |

## Directory-scoped rules

You can place `.propelignore` files in subdirectories to apply rules only inside that directory.

```text theme={null}
my-repo/
|-- .propelignore
|-- frontend/
|   `-- .propelignore
`-- backend/
    `-- .propelignore
```

* Root `.propelignore`: applies to the entire repo.
* `frontend/.propelignore`: only applies inside `frontend/`.
* `backend/.propelignore`: only applies inside `backend/`.

Example: A `frontend/.propelignore` with `**/*.test.tsx` only skips test files inside `frontend/`.

## Common patterns

### Test files

```gitignore theme={null}
**/*.test.ts
**/*.test.tsx
**/*.spec.ts
**/tests/
__tests__/
```

### Generated code

```gitignore theme={null}
**/*.generated.ts
**/*.generated.go
**/*_generated.go
dist/
build/
```

### Dependencies

```gitignore theme={null}
vendor/
node_modules/
third_party/
```

### Documentation

```gitignore theme={null}
*.md
docs/
```

### Large files

```gitignore theme={null}
*.min.js
*.bundle.js
```

## Important notes

* Main branch only: Propel reads `.propelignore` from your `main` or `master` branch, not from the PR branch.
* Hierarchical: Deeper `.propelignore` files add rules but do not override parent rules.
* Transparent: Skipped files are always shown in the review summary.

## Limits

| Limit | Value |
| - | - |
| Max `.propelignore` files per repo | 100 |
| Max file size | 100 KB |
| Max patterns per file | 1,000 |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.