You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
We generally follow the contribution guidelines of [rust-bitcoin](https://github.com/rust-bitcoin/rust-bitcoin/blob/master/CONTRIBUTING.md).
4
+
5
+
## Development Workflow
6
+
7
+
We use [`just`](https://just.systems/man/en/) for running development workflow commands. Run `just` from your shell to see the list of available commands.
8
+
9
+
### Git Hooks
10
+
11
+
To catch errors before running CI, we provide git hooks. To use them:
12
+
13
+
```bash
14
+
git config --local core.hooksPath githooks/
15
+
```
16
+
17
+
Alternatively, add symlinks in your `.git/hooks` directory to any of the githooks we provide.
18
+
19
+
## Integration Tests with Bitcoin Core
20
+
21
+
The `bitcoind-tests/` package contains integration tests that run against real Bitcoin Core instances. A separate package is used so that bitcoind version flags don't pollute the rust-psbt crate. The package is not a member of the workspace so that it doesn't effect dependency version resolution.
22
+
23
+
### NixOS Users
24
+
25
+
The auto-downloaded Bitcoin Core binaries don't work on NixOS due to dynamic linking requirements. If you're on NixOS you could manually configure the `BITCOIND_EXE` environment variable to use a Nix-provided `bitcoind` of the correct version.
0 commit comments