8000 Add contributing section to README by sgeisler · Pull Request #234 · rust-bitcoin/rust-bitcoin · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Add contributing section to README #234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 12, 2019
Merged

Add contributing section to README #234

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4c3bf07
Added contributing part to README
lucash-dev Jan 16, 2019
2120060
point to IRC
sgeisler Feb 9, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 34 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ For JSONRPC interaction with Bitcoin Core, it is recommended to use [rust-jsonrp
which uses the underlying [strason library](https://github.com/apoelstra/strason)
which parses decimal numbers as strings, preventing precision errors.


# Known limitations

## Consensus
Expand All @@ -43,8 +42,40 @@ Currently the [documentation](https://www.wpsoftware.net/rustdoc/bitcoin/)
is very sparse. Patches to add usage examples and to expand on existing
docs would be extremely appreciated.

# Contributing
Contributions are generally welcome. If you intend to make larger changes please discuss them in an issue before PRing
them to avoid duplicate work and architectural mismatches. If you have any questions or ideas you want to discuss
please join us in [#rust-bitcoin](http://webchat.freenode.net/?channels=%23rust-bitcoin) on freenode.

## Installing Rust
Rust can be installed using your package manager of choice or [rustup.rs](https://rustup.rs). The former way is
considered more secure since it typically doesn't involve trust in the CA system. But you should be aware that the version
of Rust shipped by your distribution might be out of date. Generally this isn't a problem for `rust-bitcoin` since
we support much older versions (>=1.22) than the current stable one.

## Building
The library can be built and tested using [`cargo`](https://github.com/rust-lang/cargo/):

```
git clone git@github.com:rust-bitcoin/rust-bitcoin.git
cd rust-bitcoin
cargo build
```

You can run tests with:

```
cargo test
```

Please refer to the [`cargo` documentation](https://doc.rust-lang.org/stable/cargo/) for more detailed instructions.

## Pull Requests
Every PR needs at least two reviews to get merged. During the review phase maintainers and contributors are likely to
leave comments and request changes. Please try to address them, otherwise your PR might get closed without merging after
a longer time of inactivity. If your PR isn't ready for review yet please mark it by prefixing the title with `WIP: `.

# Policy on Altcoins/Altchains
## Policy on Altcoins/Altchains

Patches which add support for non-Bitcoin cryptocurrencies by adding constants
to existing enums (e.g. to set the network message magic-byte sequence) are
Expand All @@ -58,7 +89,7 @@ cross-chain atomic swaps) are more likely to be accepted than things which
support only a single blockchain.


## Release Notes
# Release Notes

See CHANGELOG.md

0