Skip to content

docs(CONTRIBUTING): spell out Mathlib capitalization rules - #366

Merged
dtumad merged 2 commits into
Verified-zkEVM:mainfrom
BoltonBailey:numina/contributing-naming-clarification
May 2, 2026
Merged

docs(CONTRIBUTING): spell out Mathlib capitalization rules#366
dtumad merged 2 commits into
Verified-zkEVM:mainfrom
BoltonBailey:numina/contributing-naming-clarification

Conversation

@BoltonBailey

@BoltonBailey BoltonBailey commented Apr 30, 2026

Copy link
Copy Markdown
Contributor

I noticed on my other PR that the review bot uses this file as its style guide. But it runs on gemini 3 and I think it doesn't know what the capitalization conventions are / that lean4 changed them, so I have added some points from the official mathlib guide to make sure it will not mess these up.

…rules

The previous one-line "Follow Mathlib naming conventions where possible" left
too much room for interpretation — most notably, the AI style-adherence step
in the PR-summary workflow does not have access to the actual Mathlib naming
guide and was inferring rules (e.g. flagging `lowerCamelCase` definitions as
violations because Mathlib supposedly uses `snake_case` for definitions).

Quote the four capitalization rules verbatim from the Mathlib naming guide so
both contributors and any tool handed `CONTRIBUTING.md` as a style reference
have the actual conventions to check against.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@github-actions

github-actions Bot commented Apr 30, 2026

Copy link
Copy Markdown

🤖 PR Summary

Documentation

  • Capitalization Rules: Updated CONTRIBUTING.md with explicit naming conventions for types, functions, and theorems in accordance with Lean 4 and Mathlib standards.
  • Style Reference: Provides a formal guide for contributors and automated review bots to ensure naming consistency and minimize formatting errors.

Statistics

Metric Count
📝 Files Changed 1
Lines Added 5
Lines Removed 1

Lean Declarations

  • No declarations were added, removed, or affected.

sorry Tracking

  • No sorrys were added, removed, or affected.

🎨 **Style Guide Adherence**

All changes adhere to the style guide.


📄 **Per-File Summaries**
  • CONTRIBUTING.md: This change expands the contribution guidelines by providing detailed capitalization rules for Mathlib naming conventions, covering theorems, types, functions, and other terms. The update serves to clarify expectations for consistent naming standards across the library.

Last updated: 2026-05-02 14:39 UTC.

@dtumad
dtumad enabled auto-merge (squash) May 2, 2026 14:33
@dtumad
dtumad merged commit 67d8c41 into Verified-zkEVM:main May 2, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants