lbryio / lbryio/lbry.tech

Update Regtest setup / define Regtest

Open
#268 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

area: docs Content
Dominant language
JavaScript
Stars
53
Forks
67
PR merge metrics
No merged PRs in 30d

Description

As a new user coming from the infosec side of things, 'Regtest' is usually thought as dynamic brute force analysis not the actual definition of regression testing. While writing an API binding for lbrycrd I was under impression using testnet was what I needed to use for unit tests to see if my code would work, not break. There is currently no highlight to point newbie devs to lbrycrd's useful feature and it would help others like myself

Tom edit:
This should also include an update of https://lbry.tech/resources/regtest-setup to include latest install instructions / orchestrate.

Contributor guide

Open the contributing guide

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

Start with the existing regtest setup page at https://lbry.tech/resources/regtest-setup and review the issue’s distinction between regtest and testnet. Update the definition and current install/orchestration instructions, and add a clear pointer for developers writing unit tests; the page should reflect the latest setup when complete.

Written by the indexing model from the issue text.

Assessment

Domain
blockchain, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.