Documentation: Creating a README.md file for the Nim interop tests
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 624
- Forks
- 256
- Avg merge
- 1d 34m
- Merged PRs (30d)
- 47
Description
Problem
The Nim interop tests currently doesn't include any README.md. The README.md file should contain the details for running the tests. A new contributor , unfamiliar with Nim can have difficulty to run the tests.
Impact
It will make the onboarding with Pylibp2p smooth and easier for new contributor.
Solution
To create a README.md file for Nim interop test , in the same structure as present in the JS interop tests.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing the existing README.md in the JS interop tests with the Nim interop tests directory. Document the Nim interop test setup and commands needed to run the tests, following the same structure. Done means a newcomer unfamiliar with Nim can follow the README.md to run the tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- nim
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100