doc: update contributing docs, governance, and notation#462
doc: update contributing docs, governance, and notation#462fmontesi merged 3 commits intoleanprover:contributingfrom
Conversation
CONTRIBUTING.md: - Remove table of contents (GitHub interface automatically creates it) - Replace "mathlib" references with "Lean community" - Add Conventional Commits specification reference - Replace open contribution board with direct Zulip channel link - Remove duplicate "Contributing Boole examples" section - Minor formatting cleanup CODE_OF_CONDUCT.md: - Update maintainer contact link to cslib.io/Governance/ - Bump Contributor Covenant reference from v1.4 to v3.0 GOVERNANCE.md: - Update Alexandre Rademaker's affiliation to Renaissance Philanthropy NOTATION.md: - Add blank lines after section headings for consistency
There was a problem hiding this comment.
Pull request overview
Updates project documentation to improve formatting and refresh governance / contribution references across CSLib.
Changes:
- Tidy markdown formatting in
NOTATION.mdand parts ofCONTRIBUTING.md. - Update governance affiliation details in
GOVERNANCE.md. - Update Code of Conduct enforcement contact link and revise attribution section in
CODE_OF_CONDUCT.md.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
NOTATION.md |
Adds spacing after headings for readability. |
GOVERNANCE.md |
Updates a technical lead’s affiliation line. |
CONTRIBUTING.md |
Adjusts wording/links; adds Conventional Commits reference; rewraps lines. |
CODE_OF_CONDUCT.md |
Updates enforcement contact link; changes Contributor Covenant attribution/version text. |
CODE_OF_CONDUCT.md
Outdated
| Covenant](https://www.contributor-covenant.org), version 3.0, available at | ||
| https://www.contributor-covenant.org/version/3/0/code_of_conduct/ |
There was a problem hiding this comment.
The attribution was updated to “Contributor Covenant … version 3.0”, but the rest of this document still appears to be the older 1.x text (e.g., it lacks sections/wording found in the 3.0 code of conduct). Please ensure the referenced version matches the actual text: either update the body to v3.0 or keep the v1.4 attribution/link.
| Covenant](https://www.contributor-covenant.org), version 3.0, available at | |
| https://www.contributor-covenant.org/version/3/0/code_of_conduct/ | |
| Covenant](https://www.contributor-covenant.org), version 1.4, available at | |
| https://www.contributor-covenant.org/version/1/4/code_of_conduct.html |
| - [Lean automation](#lean-automation) | ||
| - [The role of AI](#the-role-of-ai) | ||
|
|
||
|
|
There was a problem hiding this comment.
Why is the table of contents removed?
There was a problem hiding this comment.
Hi @barrettcw, mainly because GitHub already provides the functionality to display the TOC. See
Keeping the TOC manually is hard and error-prone.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
barrettcw
left a comment
barrettcw
left a comment
There was a problem hiding this comment.
Mostly looks good - but wondering why you removed the TOC?
|
LGTM |
Please the the suggested changes