Skip to content

docs: Added the Readme.md file for Nim interop test - #1126

Open
ItshMoh wants to merge 6 commits into
libp2p:mainfrom
ItshMoh:nimmd
Open

ItshMoh wants to merge 6 commits into
libp2p:mainfrom
ItshMoh:nimmd

Conversation

@ItshMoh

@ItshMoh ItshMoh commented Jan 9, 2026

Copy link
Copy Markdown
Contributor

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

image

@seetadev

Copy link
Copy Markdown
Member

@ItshMoh : Hey Mohan — thanks for this PR and for taking the time to document the Nim interop tests 🙌
This is a useful and much-needed addition, especially for new contributors trying to run interop tests locally. The README is clear, scoped, and does a good job of lowering the entry barrier 👍

A couple of alignment notes and suggestions, just to make sure this lands in the right long-term place:


📍 Repo alignment for interop documentation

Similar to the other interop work we discussed recently, interop tests and their documentation are gradually being centralized under:
👉 https://github.com/libp2p/test-plans

That repo is intended to be the canonical home for:

  • Cross-implementation interop tests
  • Test orchestration logic
  • Contributor-facing docs on running and extending interop suites

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 test-plans.

Suggested path forward:

  • The content itself looks good and is worth keeping 👍

  • We may want to either:

    • Move this README (or an adapted version of it) into test-plans, or
    • Follow up with a PR to mirror this documentation there, so contributors have a single place to look for interop guidance

📦 Scope of py-libp2p

As a reminder for future interop-related PRs:

  • py-libp2p → main should stay focused on core library code and shared utilities
  • Interop logic and documentation is best kept in test-plans, where it can evolve across Go / Rust / JS / Nim consistently

✅ On the PR itself

  • Clear commit history ✔️
  • Fixing linting and version mismatches along the way is appreciated
  • README content is practical and contributor-friendly

Once we align on whether this should live here or be moved/mirrored into test-plans, I’m happy to see this merged or followed up accordingly.

Thanks again for improving the contributor experience — this kind of work really matters 👏

CCing @acul71 , @sumanjeet0012 and @dhuseby

@acul71

acul71 commented Sep 9, 2026

Copy link
Copy Markdown
Collaborator

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 acul71 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

  1. 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

  1. Fix Python prerequisite to 3.10+ (repo requires-python) instead of 3.8+.
  2. Reply to @seetadev on whether this README stays in-repo vs test-plans placement.
  3. Minor README polish (renumber test cases; mention scripts/setup_nim_echo.sh in 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation: Creating a README.md file for the Nim interop tests

3 participants