Add build instructions and style conventions to CONTRIBUTING.md#480
Open
shntnu wants to merge 1 commit intoteorth:mainfrom
Open
Add build instructions and style conventions to CONTRIBUTING.md#480shntnu wants to merge 1 commit intoteorth:mainfrom
shntnu wants to merge 1 commit intoteorth:mainfrom
Conversation
shntnu
force-pushed
the
improve-contributing-md
branch
2 times, most recently
from
920dd13 to
02f65b1
Compare
shntnu
changed the title
…le guide Document contributor guidelines that are currently only discoverable through issue discussions and PR feedback: - Build instructions (lake exe cache get && lake build) - Sorry policy with the critical caveat that exercise assignments are not always visible in Lean docstrings — a theorem may be assigned as an exercise elsewhere in the textbook (e.g., Theorem 6.1.19 is Exercise 6.1.8, but the Lean source only says "Theorem 6.1.19(a)") - Link to teorth#208 where the sorry policy was discussed - Style conventions (faithfulness over golfing, with teorth#476 as precedent for reverts of proof cleanups) - AI-assisted contribution requirements The sorry policy caveat comes from direct experience: PR teorth#477 was closed because Theorem 6.1.19 appeared non-exercise in the Lean source but is assigned as Exercise 6.1.8 in the textbook. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds build instructions and style conventions to CONTRIBUTING.md:
lake exe cache get && lake buildContext: Your recent update clarifies that solutions belong in downstream forks. I considered whether a style guide still makes sense given that framing, but looking at the PR history, there are active upstream contributions — statement/scaffold fixes (rkirov), infrastructure (david-christiansen), measure theory formalization (aodecipher) — where these conventions apply. Build instructions are useful for anyone working in a fork as well.
Separately — from my experience with PR #477, it may be worth adding a line encouraging contributors to engage with the textbook before filing proofs. I was approaching this as an AI-assisted experiment rather than learning the math, and that's probably worth discouraging.