Add usage examples of multidim-interop tests
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 65
- Forks
- 82
- PR merge metrics
- No merged PRs in 30d
Description
> Is the --help enough?
Forgive me but the help doesn't have an example either?
What I mean is "Do not run any tests including this name" is fine if you know what the test name is - is it "ping"?, is it ["nim"](https://github.com/libp2p/test-plans/issues/221)?, is it "rust-v0.51 x node-js-libp2p-head (ws, noise, yamux)"? does it include wildcards? regex?
A short section in the README would answer this question and help out people who aren't familiar with this test suite.
_Originally posted by @achingbrain in https://github.com/libp2p/test-plans/issues/225#issuecomment-1628389491_
Contributor guide
No contributing guide indexed for this repository
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 with the test suite's --help output and the README to identify how multidim-interop test names are formed and filtered. Add a short README section with concrete exclusion examples, including whether names such as ping or language-specific labels support wildcards or regexes; done means newcomers can understand and reproduce the documented filtering behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, nim, rust
- Domain
- documentation, testing-qa
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100