Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -461,6 +461,8 @@ Before considering your work complete, verify:
- [ ] Docstrings present for main definitions
- [ ] `research open`, `textbook` and `research solved` docstrings include a concise description
- [ ] Code properly formatted and readable
- [ ] Searched `FormalConjecturesForMathlib` and neighboring files for existing definitions, API, and notation before adding new ones
- [ ] Notes to reviewers (formalization choices, caveats) are in the PR description, not the Lean file

### Testing Definitions

Expand Down Expand Up @@ -490,6 +492,8 @@ theorem myNewClass_sanity_check :
- Add large proofs (this is a benchmark repository, not a proof repository)
- Use camelCase for theorem names
- Create placeholder definitions in FormalConjecturesForMathlib/
- Redefine notation or API that already exists in `FormalConjecturesForMathlib` or a neighboring problem file
- Put meta-commentary or notes-to-reviewers in Lean files (they belong in the PR description)

✅ **DO:**

Expand Down
25 changes: 25 additions & 0 deletions FormalConjectures/ErdosProblems/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,28 @@ An example of this would be:
- [Va99] Various, Some of Paul's favorite problems. Booklet produced for the conference "Paul Erdős
and his mathematics", Budapest, July 1999 (1999).
```

## Before requesting review

A checklist of the corrections that come up most often in review. Ticking
these off first (yourself, or whatever agent prepared the PR) usually saves a
review round trip:

1. **Docstrings quote the website verbatim.** Copy the LaTeX from
erdosproblems.com rather than rephrasing it. Only deviate to fix a genuine
error or inaccuracy in the original formulation.
2. **Solved problems cite the solution.** The text below the problem box
typically explains who solved it and in which paper; copy that sentence
verbatim into the docstring as well.
3. **Search before defining.** Check `FormalConjecturesForMathlib` and
neighboring problem files for existing definitions, API, and notation
before introducing your own. If something you need seems generally useful,
it belongs in `FormalConjecturesForMathlib`, not inlined in the problem
file.
4. **Keep commentary out of the Lean file.** Notes to reviewers, formalization
choices, and caveats belong in the pull request description, not the
source.
5. **Use LaTeX, not backticks, for mathematics in docstrings.** See
`AGENTS.md` for the exceptions on the Lean-API side.
6. **Add sanity tests for new definitions.** A nontrivial definition should
come with at least one `@[category test]` statement exercising it.
Loading