Repository navigation
Conversation
Write down the scope and evidence rules from docling-project#428 so that contributors find them before they open a pull request: - CONTRIBUTING.md: new "Submitting pull requests" section (scope, evidence from real documents, rendering changes, ground truth). - .github/PULL_REQUEST_TEMPLATE.md: the docling-project#428 checklist. - tests/README.md: say that unit tests do not replace real-document evidence, that the pypdfium2 report is not the enforced image test, and that bumping HF_DATASET_REVISION is a maintainer step. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Signed-off-by: Jeff Witt <1848307+wittjeff@users.noreply.github.com>
Contributor
|
✅ DCO Check Passed Thanks @wittjeff, all your commits are properly signed off. 🎉 |
Contributor
Merge Protections🟢 Merge protection satisfied — ready to merge. Show 1 satisfied protection🟢 Enforce conventional commitMake sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
|
7 tasks
PeterStaar-IBM
self-requested a review
October 29, 2026 15:06
This branch has not been deployed
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
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.
This PR writes down the scope and evidence rules from #428, so that contributors find them before they open a pull request. The rules are copied from #428 without additions.
Changes:
CONTRIBUTING.md: a new "Submitting pull requests" section with four parts: scope, evidence from real documents, rendering changes, and ground truth..github/PULL_REQUEST_TEMPLATE.md(new): the Consolidating the open rendering, text and font PRs: scope and evidence requirements #428 checklist, plus fields for evidence and ground-truth changes. The repo had no pull request template before.tests/README.md: three short additions where the old text pointed contributors the other way:render_pypdfium_page(),measure_image_pair()) can build that test.HF_DATASET_REVISIONare maintainer steps. Contributors list the changed pages and give the reasons.Evidence: Documentation only. No code, test or ground-truth change.
Ground truth changes: None.
Checklist:
main, no merge commitsRelates to #428. If you want different wording, or the rules in another place (for example in the community repository), I can change or close this PR.
🤖 Generated with Claude Code