Conversation
|
@ItshMoh : Hey Mohan — thanks for this PR and for taking the time to document the Nim interop tests 🙌 A couple of alignment notes and suggestions, just to make sure this lands in the right long-term place: 📍 Repo alignment for interop documentationSimilar to the other interop work we discussed recently, interop tests and their documentation are gradually being centralized under: That repo is intended to be the canonical home for:
Since this README is specifically about running Nim ↔ Python interop tests, it would be ideal for this documentation to eventually live alongside the Nim interop test plan in Suggested path forward:
📦 Scope of py-libp2pAs a reminder for future interop-related PRs:
✅ On the PR itself
Once we align on whether this should live here or be moved/mirrored into Thanks again for improving the contributor experience — this kind of work really matters 👏 CCing @acul71 , @sumanjeet0012 and @dhuseby |
|
Triage note: candidate for merge after maintainer review (docs-only Nim interop README). CLEAN and CI green. We will run the full PR review prompt before any squash-merge. |
acul71
left a comment
There was a problem hiding this comment.
Maintainer review (triage)
Merge Readiness: Needs fixes
Full review: see maintainer notes from the AI PR review prompt (local artifact downloads/AI-PR-REVIEWS/1126/AI-PR-REVIEW-1126-0.md).
Blockers
- Missing newsfragment for linked issue #1125 — please add
newsfragments/1125.docs.rst(docs type) with a short ReST description and trailing newline.
Also please address
- Fix Python prerequisite to 3.10+ (repo
requires-python) instead of 3.8+. - Reply to @seetadev on whether this README stays in-repo vs
test-plansplacement. - Minor README polish (renumber test cases; mention
scripts/setup_nim_echo.shin the directory structure).
Local lint/typecheck/docs build were clean; CI mostly green (Windows core still pending at review time). Re-request review after the newsfragment lands.
This pr includes the README.md file in the Nim interop tests. The README.md files includes details for running the tests.
fixes #1125
Cute Animal Picture