Lean PR
PR conventions for the leanprover/lean4 repository. Use when creating pull requests, writing commit messages, or following project conventions for Lean contributions.
MCP get_skill({ skillId: "lean-pr-d39f9884" })Use this skill with your agent
Create a free account and connect via MCP
# Lean PR Conventions ## Commit Message Format All PR titles must follow the format: ``` <type>: <subject> ``` **`<type>`** is one of: - `feat` — feature - `fix` — bug fix - `doc` — documentation - `style` — formatting - `refactor` - `test` — adding missing tests - `chore` — maintenance - `perf` — performance improvement **`<subject>`**: imperative present tense, lowercase, no period. For `feat`/`fix` PRs, begin the description with "This PR " — the first paragraph is automatically used in release notes. ## Changelog Labels Every `feat` or `fix` PR must have a `changelog-*` label: | Label | Category | |-------|----------| | `changelog-language` | Language features and metaprograms | | `changelog-tactics` | User-facing tactics | | `changelog-server` | Language server, widgets, and IDE extensions | | `changelog-pp` | Pretty printing | | `changelog-library` | Library | | `changelog-compiler` | Compiler, runtime, and FFI | | `changelog-lake` | Lake | | `changelog-doc` | Documentation | | `changelog-ffi` | FFI changes | | `changelog-other` | Other changes | | `changelog-no` | Do not include in changelog | ## Module System for `src/` Files Files in `src/Lean/`, `src/Std/`, and `src/lake/Lake/` must have both `module` and `prelude` declarations. With `prelude`, nothing is auto-imported — you must explicitly import `Init.*` modules. ```lean module prelude import Init.While import Init.Data.String.TakeDrop public import Lean.Compiler.NameMangling ``` Check existing files in the same directory for the pattern. Files outside these directories (e.g. `tests/`, `script/`) use just `module`. ## Copyright Headers New files in `src/` require a copyright header: ``` /- Copyright (c) YYYY Author or Organization. All rights reserved. Released under Apache 2.0 license as described in the file LICENSE. Authors: Author Name -/ ``` Check other recent files in the repository to determine the correct copyright holder. Test files (in `tests/`) do not need copyright headers. ## PR Conventions Keep descriptions **concise**: - Start with a paragraph beginning "This PR ..." — no section headers - No "## Summary" header — just start with the text - No "Test plan" section — we rely on CI - No "Implementation details" section — the code speaks for itself
Related Skills
More skills in Data, AI & Research
Ablation Planner
Use when main results pass result-to-claim (`claim_supported = yes` or `partial`) and ablation studies are needed for paper submission. A secondary Codex agent designs ablations from a reviewer's perspective; the local executor reviews feasibility and implements.
Ablation Planner
Use when main results pass result-to-claim (claim_supported=yes or partial) and ablation studies are needed for paper submission.
About
Provides information about the bitwize-music plugin, its version, and its creator. Use when the user asks about the plugin, its purpose, version, or capabilities.
Ab Test Analysis
Analyze A/B test results with statistical significance, sample size validation, confidence intervals, and ship/extend/stop recommendations. Use when evaluating experiment results, checking if a test reached significance, interpreting split test data, or deciding whether to ship a variant.
Academic Search
Search and analyze academic literature. Find papers, understand research methodologies, and synthesize academic findings for research projects.
Adaptyv
How to use the Adaptyv Bio Foundry API and Python SDK for protein experiment design, submission, and results retrieval. Use this skill whenever the user mentions Adaptyv, Foundry API, protein binding assays, protein screening experiments, BLI/SPR assays, thermostability assays, or wants to submit protein sequences for experimental characterization. Also trigger when code imports `adaptyv`, `adaptyv_sdk`, or `FoundryClient`, or references `foundry-api-public.adaptyvbio.com`.
Explore Other Categories
Skills from other categories with shared topics
Mathlib PR
PR conventions for leanprover-community/mathlib4. Use when creating pull requests, writing commit messages, or managing labels for Mathlib contributions.
Mathlib Review
Review guidelines for Mathlib PRs. Use when reviewing pull requests, checking code quality, or assessing whether a PR is ready to merge.
Lean Bisect
Bisect Lean toolchain versions to find where behavior changes. Use when trying to identify which Lean 4 commit caused a regression or behavior change.