Skip to content

feat: add CHANGELOG.md and update README.md#3

Merged
xdustinface merged 1 commit into
mainfrom
feat/changelog-readme
Feb 12, 2026
Merged

feat: add CHANGELOG.md and update README.md#3
xdustinface merged 1 commit into
mainfrom
feat/changelog-readme

Conversation

@xdustinface
Copy link
Copy Markdown
Contributor

@xdustinface xdustinface commented Feb 12, 2026

Summary by CodeRabbit

  • Documentation
    • Updated setup and Quick Start to use regtest-15000 and clarified data/extraction paths
    • Expanded dataset and wallet data semantics, including wallet export/import and sync expectations
    • Added generation and wallet-sync instructions plus development testing guidance (pre-commit, pytest)
    • Expanded project layout and reorganized development/regeneration guidance
  • Chores
    • Added v0.0.2 changelog entry documenting SPV integration tests and generator improvements

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 12, 2026

Warning

Rate limit exceeded

@xdustinface has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 22 minutes and 45 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📝 Walkthrough

Walkthrough

The PR updates documentation and release notes for SPV integration tests. CHANGELOG.md gains a v0.0.2 entry describing generator improvements and added tests; README.md is expanded with updated Quick Start, dataset/wallet layout, generation/export scripts, and development/testing guidance.

Changes

Cohort / File(s) Summary
CHANGELOG Entry
CHANGELOG.md
Added v0.0.2 release notes documenting generator improvements (PR #1) and initial SPV integration tests, plus CI/tooling mentions (pre-commit, GitHub Actions).
README and Project Docs
README.md
Reworked Quick Start to reference regtest-15000; generalized image/data layout to regtest-<height>; expanded dataset and wallet JSON semantics (mnemonics, addresses, UTXOs, transaction history); added generation (generate.py) and export (export_wallets.py) workflows, wallet-sync strategy, project structure, and development/testing steps (pre-commit, pytest, DASHD_PATH).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 I nibble lines and tidy trails,
I stash the seeds of tests and tales,
v0.0.2 hops into view,
Wallets, blocks, and docs anew —
A rabbit's cheer for fixes true.

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and accurately summarizes the main changes: adding a CHANGELOG.md file and updating README.md documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/changelog-readme

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🤖 Fix all issues with AI agents
In `@CHANGELOG.md`:
- Around line 9-10: Update the two changelog bullets to normalize
capitalization: change "Integration" to lowercase "integration" in the phrase
"implement unit and Integration tests for the generator" and correct "Github" to
"GitHub" in the phrase "add `pre-commit` and Github actions for basic CI"; keep
the rest of the text and links unchanged so the lines read with consistent
"integration" and "GitHub".

In `@README.md`:
- Around line 100-105: The README is missing a trailing newline which triggers
the pre-commit end-of-file-fixer; open the README.md and add a single newline
character at the end of the file (ensure the file ends with a blank
line/linefeed), save and amend the commit so CI no longer reports changes.
- Around line 11-13: Update the Quick Start download URL in the README: replace
the curl command's GitHub owner from "xdustinface" to "dashpay" so the download
uses
"https://github.com/dashpay/regtest-blockchain/releases/latest/download/regtest-15000.tar.gz"
(update the line containing the curl -LO command and ensure the tar extraction
line remains unchanged).

Comment thread CHANGELOG.md
Comment on lines +9 to +10
- implement unit and Integration tests for the generator ([#1](https://github.com/dashpay/regtest-blockchain/pull/1)) @xdustinface
- add `pre-commit` and Github actions for basic CI ([#2](https://github.com/dashpay/regtest-blockchain/pull/2)) @xdustinface
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Normalize capitalization for consistency (“integration”, “GitHub”).

Minor doc polish: “Integration tests” mid-sentence and “Github” are inconsistent with common style.

🤖 Prompt for AI Agents
In `@CHANGELOG.md` around lines 9 - 10, Update the two changelog bullets to
normalize capitalization: change "Integration" to lowercase "integration" in the
phrase "implement unit and Integration tests for the generator" and correct
"Github" to "GitHub" in the phrase "add `pre-commit` and Github actions for
basic CI"; keep the rest of the text and links unchanged so the lines read with
consistent "integration" and "GitHub".

Comment thread README.md
Comment thread README.md Outdated
@xdustinface xdustinface force-pushed the feat/changelog-readme branch from 4ba8260 to e4fa7cc Compare February 12, 2026 11:04
@xdustinface xdustinface force-pushed the feat/changelog-readme branch from e4fa7cc to d30ac6f Compare February 12, 2026 11:07
@xdustinface xdustinface merged commit f013b57 into main Feb 12, 2026
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant