Skip to content

docs: Add documentation for adding new features#302

Open
tvpeter wants to merge 1 commit into
bitcoindevkit:masterfrom
tvpeter:docs/adding-a-feature
Open

docs: Add documentation for adding new features#302
tvpeter wants to merge 1 commit into
bitcoindevkit:masterfrom
tvpeter:docs/adding-a-feature

Conversation

@tvpeter

@tvpeter tvpeter commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

Description

With the introduction of modular design architecture in the app (PR #278) , new contributors may find it challenging adding new features/commands. This PR adds a documentation section to provide them with an easy-to-follow guide.

Fixes #298

Changelog notice

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

@tvpeter tvpeter self-assigned this Jul 14, 2026
@tvpeter tvpeter added this to the CLI 4.0.0 milestone Jul 14, 2026
@codecov

codecov Bot commented Jul 14, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 57.45%. Comparing base (7c2dfac) to head (14c34d6).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #302   +/-   ##
=======================================
  Coverage   57.45%   57.45%           
=======================================
  Files          22       22           
  Lines        3695     3695           
=======================================
  Hits         2123     2123           
  Misses       1572     1572           
Flag Coverage Δ
rust 57.45% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tvpeter
tvpeter force-pushed the docs/adding-a-feature branch from 7391aad to 14c34d6 Compare July 18, 2026 00:23
Comment thread NEW_FEATURE.md
Comment on lines +88 to +90
fn execute(&self, contex: &mut AppContext<OfflineOperations<'_>>) -> Result<Self::Output, Error> {
// Access the loaded wallet via the context state
let wallet = &contex.state.wallet;

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nit: Is the contex parameter here a typo or intentional?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Add a section in the README that explains how to add new features to the new design.

2 participants