Skip to content

Commit f8da0a4

Browse files
committed
Break out contributing docs
1 parent 8f88b0b commit f8da0a4

File tree

2 files changed

+28
-33
lines changed

2 files changed

+28
-33
lines changed

CONTRIBUTING.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Contributing
2+
3+
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.

README.md

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -3,46 +3,16 @@
33
Implementation of the Partially Signed Bitcoin Transaction Format as defined in [BIP-174] and
44
PSBT version 2 as defined in [BIP-370].
55

6-
## Contributing
7-
8-
For now we more or less just follow the contribution guidelines of
9-
[rust-bitcoin](https://github.com/rust-bitcoin/rust-bitcoin/CONTRIBUTING.md).
10-
11-
### Minimum Supported Rust Version (MSRV)
6+
## Minimum Supported Rust Version (MSRV)
127

138
This library should always compile with any combination of features on **Rust 1.74.0**.
149

1510
To build with the MSRV you will likely need to pin a bunch of dependencies, see `./contrib/test.sh`
1611
for the current list.
1712

18-
### Just
19-
20-
We support [`just`](https://just.systems/man/en/) for running dev workflow commands. Run `just` from
21-
your shell to see list available sub-commands.
22-
23-
### Building the docs
24-
25-
We build docs with the nightly toolchain, you may wish to use the following shell alias to check
26-
your documentation changes build correctly.
27-
28-
```
29-
alias build-docs='RUSTDOCFLAGS="--cfg docsrs" cargo +nightly rustdoc --features="$FEATURES" -- -D rustdoc::broken-intra-doc-links'
30-
```
31-
32-
### Githooks
33-
34-
To assist devs in catching errors _before_ running CI we provide some githooks. If you do not
35-
already have locally configured githooks you can use the ones in this repository by running, in the
36-
root directory of the repository:
37-
```
38-
git config --local core.hooksPath githooks/
39-
```
40-
41-
Alternatively add symlinks in your `.git/hooks` directory to any of the githooks we provide.
42-
43-
### rustfmt
13+
## Contributing
4414

45-
We format with `cargo +nightly fmt`, see `./rusntfmt.toml` for the current configuration.
15+
Contributions are welcome! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines.
4616

4717
## License
4818

0 commit comments

Comments
 (0)