libp2p / libp2p/test-plans

docs: Update test plans doc

Open
#260 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

need/triage
Dominant language
Python
Stars
65
Forks
82
PR merge metrics
No merged PRs in 30d

Description

          I did not find the documentation in the test plans repo to be sufficient to actually run the tests locally; a number of extra steps were required.

Perhaps we can consolidate these in a future PR.

Originally posted by @achingbrain in https://github.com/libp2p/js-libp2p/pull/1864#discussion_r1269032329

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Review the test plans documentation and identify the extra steps needed to run the tests locally, as described in the issue. Consolidate those setup steps in the documentation and verify that the tests can be run locally using the updated instructions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, testing-qa
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.