From f5bff82e701b58f5f5a0d9325cd5ec4a0bbcab34 Mon Sep 17 00:00:00 2001 From: Mathieu Kniewallner Date: Mon, 19 Aug 2024 11:38:08 +0200 Subject: [PATCH] docs(contributing): remove TOC (#12903) Co-authored-by: Micha Reiser --- CONTRIBUTING.md | 31 +------------------------------ 1 file changed, 1 insertion(+), 30 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 959775e8b1..b89d833254 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,35 +2,6 @@ Welcome! We're happy to have you here. Thank you in advance for your contribution to Ruff. -- [The Basics](#the-basics) - - [Prerequisites](#prerequisites) - - [Development](#development) - - [Project Structure](#project-structure) - - [Example: Adding a new lint rule](#example-adding-a-new-lint-rule) - - [Rule naming convention](#rule-naming-convention) - - [Rule testing: fixtures and snapshots](#rule-testing-fixtures-and-snapshots) - - [Example: Adding a new configuration option](#example-adding-a-new-configuration-option) -- [MkDocs](#mkdocs) -- [Release Process](#release-process) - - [Creating a new release](#creating-a-new-release) -- [Ecosystem CI](#ecosystem-ci) -- [Benchmarking and Profiling](#benchmarking-and-profiling) - - [CPython Benchmark](#cpython-benchmark) - - [Microbenchmarks](#microbenchmarks) - - [Benchmark-driven Development](#benchmark-driven-development) - - [PR Summary](#pr-summary) - - [Tips](#tips) - - [Profiling Projects](#profiling-projects) - - [Linux](#linux) - - [Mac](#mac) -- [`cargo dev`](#cargo-dev) -- [Subsystems](#subsystems) - - [Compilation Pipeline](#compilation-pipeline) - - [Import Categorization](#import-categorization) - - [Project root](#project-root) - - [Package root](#package-root) - - [Import categorization](#import-categorization-1) - ## The Basics Ruff welcomes contributions in the form of pull requests. @@ -412,7 +383,7 @@ We have several ways of benchmarking and profiling Ruff: - Microbenchmarks which run the linter or the formatter on individual files. These run on pull requests. - Profiling the linter on either the microbenchmarks or entire projects -> \[!NOTE\] +> **Note** > When running benchmarks, ensure that your CPU is otherwise idle (e.g., close any background > applications, like web browsers). You may also want to switch your CPU to a "performance" > mode, if it exists, especially when benchmarking short-lived processes.