Skip to content

Updating docs for Py Config #436

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jul 9, 2025
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,18 @@ description: The latest updates and changes to CodeRabbit.
sidebar_position: 13
---

## July 9, 2025

### Python Static Analysis Tools Configuration Requirement

We've updated Pylint and Flake8 to ensure they run only with proper configuration files:

- **[Pylint](https://docs.coderabbit.ai/tools/pylint)**: Now requires a configuration file (`.pylintrc`, `pylintrc`, `.pylintrc.toml`, or `pylintrc.toml`) to run. CodeRabbit will not run Pylint if no config file is found.

- **[Flake8](https://docs.coderabbit.ai/tools/flake8)**: Requires a `.flake8` configuration file to run. CodeRabbit will not run Flake8 if no config file is found.

This ensures that these tools operate with your project's specific coding standards and preferences. For detailed configuration information, refer to our [Pylint](/tools/pylint) and [Flake8](/tools/flake8) documentation pages.

## July 3, 2025

### Enhanced Python Static Analysis: Flake8 Support
Expand Down
8 changes: 8 additions & 0 deletions docs/tools/flake8.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,14 @@ Flake8 will run on files with the following extensions:

- `*.py`

## Configuration

Flake8 supports the following config files:

- `.flake8`

CodeRabbit will not run Flake8 if no config file is found.

## Features

Flake8 can detect many issues such as:
Expand Down
11 changes: 11 additions & 0 deletions docs/tools/pylint.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,17 @@ Pylint will run on files with the following extensions:

- `*.py`

## Configuration

Pylint supports the following config files:

- `.pylintrc`
- `pylintrc`
- `.pylintrc.toml`
- `pylintrc.toml`

CodeRabbit will not run Pylint if no config file is found.

## Features

Pylint can detect many issues such as:
Expand Down