Proposal: --explain mode for beginners
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
Start by reading docs/json-schema.md to understand the stated stability constraint, then compare the proposed tx, decode, and verify commands and the --explain versus separate-command options. The issue is a discussion proposal, not an implementation task; done means agreeing on a direction and creating a scoped implementation issue.
Written by the indexing model from the issue text.
Description
An idea to discuss before anyone writes code: a way to explain each field of the text output in plain language, for people learning how Bitcoin works. For example, btc-toolkit tx <txid> --explain could add a line under "vSize" saying what virtual size is and why fees are paid per vbyte.
Input welcome on
- Which commands would benefit most (
tx,decode,verify?). - A flag (
--explain) or a separate command (explain tx <txid>)? - How to keep the explanations short, accurate and testable.
- It must not change the
--jsonoutput (see the stability policy indocs/json-schema.md).
Comment with your view. Once there is a direction, this becomes an implementation issue.
- Dominant language
- Python
- Stars
- 2
- Forks
- 1
- Avg merge
- 1h 22m
- Merged PRs (30d)
- 41
Getting set up
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing 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.
More from devdavidejesus/btc-toolkit
-
documentation good first issue
Difficulty 2/5 Half a day Newbie friendliness 78/100
devdavidejesus/btc-toolkit#63 ·
Maintainers usually reply within 1 day
-
help wanted
Difficulty 3/5 1-2 days Newbie friendliness 58/100
devdavidejesus/btc-toolkit#66 ·
Maintainers usually reply within 1 day
-
enhancement help wanted
Difficulty 4/5 3-5 days Newbie friendliness 58/100
devdavidejesus/btc-toolkit#65 ·
Maintainers usually reply within 1 day
-
enhancement help wanted
Difficulty 4/5 3-5 days Newbie friendliness 68/100
devdavidejesus/btc-toolkit#64 ·
Maintainers usually reply within 1 day
All issues in devdavidejesus/btc-toolkit
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
521xueweihan/HelloGitHub#4150 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
aws-samples/sample-per-model-bedrock#595 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
bug connectors
Difficulty 1/5 Under an hour Newbie friendliness 67/100
pyinfra-dev/pyinfra#2036 ·
Maintainers usually reply within 9 days
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day