docs: add Latest News section to README - #37
Conversation
Greptile SummaryThis PR adds a "Latest News 🔥" section near the top of the README (between the badge block and the "Why pr-split?" section) to surface three recently shipped features to new visitors.
The change is purely additive documentation; no code is modified. The prose is clear, the placement is appropriate, and the formatting renders cleanly as standard GitHub Markdown. Confidence Score: 5/5Documentation-only change; safe to merge immediately. The PR touches only README.md with a purely additive documentation section. No code, no configuration, no logic is changed. Prose is accurate, well-placed, and renders correctly in GitHub Markdown. No issues found that would warrant blocking merge. No files require special attention. Important Files Changed
Flowchart%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[pr-split: split PR] --> B{Partition backend}
B --> C[LLM]
B --> D[Graph]
B --> E[CP-SAT]
C & D & E --> F{LOC bounds check\n--min-loc / --max-loc}
F -->|Undersized groups| G[Merge groups]
F -->|Oversized groups| H[Penalise / split]
F -->|Within bounds| I[Output split plan]
G & H --> J{--max-refinement-iterations set?}
J -->|Yes| K[Feed violations back to LLM\nRefinement loop]
K --> F
J -->|No| I
I --> L[Create sub-PRs as DAG]
Reviews (2): Last reviewed commit: "docs: add fire emoji to Latest News head..." | Re-trigger Greptile |
There was a problem hiding this comment.
Code Review
This pull request updates the README.md file to include a 'Latest News' section detailing new features such as smart LOC bounds, an LLM refinement loop, and auto-derived minimum LOC settings. I have reviewed the changes and suggest updating the spelling of 'penalised' to 'penalized' to maintain consistency with the project's American English style.
|
|
||
| ## Latest News 🔥 | ||
|
|
||
| **Smart LOC Bounds**: Configure `--min-loc` and `--max-loc` to control sub-PR size. All three partitioning backends (LLM, graph, CP-SAT) now enforce both lower and upper bounds — undersized groups get merged, oversized groups get penalised. |
There was a problem hiding this comment.
For consistency with American English spelling used elsewhere in the project (e.g., normalize), it's recommended to use 'penalized' instead of 'penalised'.
| **Smart LOC Bounds**: Configure `--min-loc` and `--max-loc` to control sub-PR size. All three partitioning backends (LLM, graph, CP-SAT) now enforce both lower and upper bounds — undersized groups get merged, oversized groups get penalised. | |
| **Smart LOC Bounds**: Configure `--min-loc` and `--max-loc` to control sub-PR size. All three partitioning backends (LLM, graph, CP-SAT) now enforce both lower and upper bounds — undersized groups get merged, oversized groups get penalized. |
Summary
Test plan