Release preparation: contribution info, better Cargo.toml, coverage

CONTRIBUTING.md

@@ -1,20 +1,24 @@
-# Contributing to LNP/BP Core Library
+Contributing to LNP/BP Core Library
+===================================
 
-The LNP/BP project operates an open contributor model where anyone is
-welcome to contribute towards development in the form of peer review, documentation,
+The LNP/BP project operates an open contributor model where anyone is welcome to 
+contribute towards development in the form of peer review, documentation, 
 testing and patches.
 
-Anyone is invited to contribute without regard to technical experience, "expertise", OSS
-experience, age, or other concern. However, the development of standards & reference implementations demands a
-high-level of rigor, adversarial thinking, thorough testing and risk-minimization.
-Any bug may cost users real money. That being said, we deeply welcome people contributing
-for the first time to an open source project or pick up Rust while contributing. Don't be shy,
+Anyone is invited to contribute without regard to technical experience, 
+"expertise", OSS experience, age, or other concern. However, the development of 
+standards & reference implementations demands a high-level of rigor, adversarial 
+thinking, thorough testing and risk-minimization. Any bug may cost users real 
+money. That being said, we deeply welcome people contributing for the first time 
+to an open source project or pick up Rust while contributing. Don't be shy, 
 you'll learn.
 
-## Communications Channels
+Communications Channels
+-----------------------
 
-Communication about LNP/BP standards & imlementations happens primarily in Telegram group
-https://t.me/rgbtelegram (due to historical reasons), but also #lnp-pb on IRC Freenode.
+Communication about LNP/BP standards & implementations happens primarily 
+in #lnp-pb  IRC chat on Freenode with the logs available at 
+<http://gnusha.org/lnp-bp/>
 
 Discussion about code base improvements happens in GitHub issues and on pull
 requests.
@@ -35,65 +39,86 @@ To contribute a patch, the worflow is a as follows:
   2. Create topic branch
   3. Commit patches
 
-In general commits should be atomic and diffs should be easy to read.
-For this reason do not mix any formatting fixes or code moves with
-actual code changes. Further, each commit, individually, should compile
-and pass tests, in order to ensure git bisect and other automated tools
-function properly.
+In general commits should be atomic and diffs should be easy to read. For this 
+reason do not mix any formatting fixes or code moves with actual code changes. 
+Further, each commit, individually, should compile and pass tests, in order to 
+ensure git bisect and other automated tools function properly.
 
-When adding a new feature thought
-must be given to the long term technical debt. Every new features should
-be covered by unit tests.
+When adding a new feature thought must be given to the long term technical debt. 
+Every new features should be covered by unit tests.
 
-When refactoring, structure your PR to make it easy to review and don't
-hestitate to split it into multiple small, focused PRs.
+When refactoring, structure your PR to make it easy to review and don't hesitate
+to split it into multiple small, focused PRs.
 
-The Minimal Supported Rust Version is nightly for the period of active development; it is enforced by our Travis.
-Later we plan to fix to some specific Rust version after the initial library release.
+The Minimal Supported Rust Version is nightly for the period of active 
+development; it is enforced by our Travis. Later we plan to fix to some specific 
+Rust version after the initial library release.
 
 Commits should cover both the issue fixed and the solution's rationale.
-These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in mind.
+These [guidelines](https://chris.beams.io/posts/git-commit/) should be kept in 
+mind.
+
+To facilitate communication with other contributors, the project is making use 
+of GitHub's "assignee" field. First check that no one is assigned and then 
+comment suggesting that you're working on it. If someone is already assigned, 
+don't hesitate to ask if the assigned party or previous commenters are still 
+working on it if it has been awhile.
+
+Branches information
+--------------------
+
+The main library development happens in the `master` branch. This branch must 
+always compile without errors (using Travis CI). All external contributions are 
+made within PRs into this branch.
+
+Each commitment within a PR to the `master` must 
+* compile without errors;
+* contain all necessary tests for the introduced functional;
+* contain all docs.
+
+Additionally to the `master` branch the repository has `develop` branch for any 
+experimental developments. This branch may not compile and should not be used by 
+any projects depending on `lnpbp` library.
 
-To facilitate communication with other contributors, the project is making use of
-GitHub's "assignee" field. First check that no one is assigned and then comment
-suggesting that you're working on it. If someone is already assigned, don't hesitate
-to ask if the assigned party or previous commenters are still working on it if it has
-been awhile.
 
 Peer review
 -----------
 
 Anyone may participate in peer review which is expressed by comments in the pull
 request. Typically reviewers will review the code for obvious errors, as well as
 test out the patch set and opine on the technical merits of the patch. PR should
-be reviewed first on the conceptual level before focusing on code style or grammar
-fixes.
+be reviewed first on the conceptual level before focusing on code style or 
+grammar fixes.
 
 Coding Conventions
 ------------------
 
-Rust-fmt should be used as a coding style recommendations in general, with a default coding style.
-By default, Rustfmt uses a style which conforms to the [Rust style guide][style
-guide] that has been formalized through the [style RFC process][fmt rfcs].
+Rust-fmt should be used as a coding style recommendations in general, with a 
+default coding style. By default, Rustfmt uses a style which conforms to the 
+[Rust style guide][style guide] that has been formalized through the [style RFC 
+process][fmt rfcs]. It is also required to run `cargo fmt` to make the code 
+formatted according to `rustfmt` parameters
 
 
 Security
 --------
 
-Security is the primary focus of Rust-LNPBP; disclosure of security vulnerabilites
-helps prevent user loss of funds. If you believe a vulnerability may affect other 
-implementations, please inform them.
+Security is the primary focus of Rust-LNPBP; disclosure of security 
+vulnerabilities helps prevent user loss of funds. If you believe a vulnerability 
+may affect other  implementations, please inform them.
 
-Note that Rust-LNPBP is currently considered "pre-production" during this time, there
-is no special handling of security issues. Please simply open an issue on Github.
+Note that Rust-LNPBP is currently considered "pre-production" during this time, 
+there is no special handling of security issues. Please simply open an issue on 
+Github.
 
 Testing
 -------
 
-Related to the security aspect, Rust-LNPBP developers take testing
-very seriously. Due to the modular nature of the project, writing new functional
-tests is easy and good test coverage of the codebase is an important goal. Refactoring
-the project to enable fine-grained unit testing is also an ongoing effort.
+Related to the security aspect, Rust-LNPBP developers take testing very 
+seriously. Due to the modular nature of the project, writing new functional
+tests is easy and good test coverage of the codebase is an important goal. 
+Refactoring the project to enable fine-grained unit testing is also an ongoing 
+effort.
 
 Fuzzing is heavily encouraged: feel free to add related material under `fuzz/`
 

Cargo.toml

@@ -33,11 +33,11 @@ lnpbp_derive = { path = "derive" }
 lazy_static = "~1.4.0"
 bech32 = "~0.7.2"
 ed25519-dalek = { version = "~1.0.0", optional = true }
-bitcoin = { git = "https://github.com/LNP-BP/rust-bitcoin", branch = "develop" }
-bitcoin_hashes = { git = "https://github.com/LNP-BP/bitcoin_hashes", tag = "lnpbp-v0.1.0-beta-4" } # we need macro from here
-lightning = { git = "https://github.com/LNP-BP/rust-lightning", branch = "develop", optional = true }
-lightning-net-tokio = { git = "https://github.com/LNP-BP/rust-lightning", branch = "develop", optional = true }
-miniscript = { git = "https://github.com/LNP-BP/rust-miniscript", branch = "develop" }
+bitcoin = "~0.25.0"
+bitcoin_hashes = "~0.9.0" # we need macro from here
+lightning = { version = "~0.0.11", optional = true }
+lightning-net-tokio = { version = "~0.0.4", optional = true }
+miniscript = "~1.0.0"
 # We are of no control of what's happening in Grin and would like to prevent
 # updates w/o checking them manually
 grin_secp256k1zkp = { version = "=0.7.9", optional = true }
@@ -56,8 +56,15 @@ url = { version = "~2.1.1", optional = true }
 serde_crate = { package = "serde", version = "~1.0.106", features = ["derive"], optional = true }
 
 [dev-dependencies]
-miniscript = { git = "https://github.com/LNP-BP/rust-miniscript", branch = "develop", features = ["compiler"] }
-bitcoin = { git = "https://github.com/LNP-BP/rust-bitcoin", branch = "develop", features = ["rand"] }
+miniscript = { version = "~1.0.0", features = ["compiler"] }
+bitcoin = { version = "~0.25.0", branch = "develop", features = ["rand"] }
+
+[patch.crates-io]
+bitcoin = { git = "https://github.com/LNP-BP/rust-bitcoin", branch = "develop" }
+bitcoin_hashes = { git = "https://github.com/LNP-BP/bitcoin_hashes", tag = "lnpbp-v0.1.0-beta-4" }
+lightning = { git = "https://github.com/LNP-BP/rust-lightning", branch = "develop", optional = true }
+lightning-net-tokio = { git = "https://github.com/LNP-BP/rust-lightning", branch = "develop", optional = true }
+miniscript = { git = "https://github.com/LNP-BP/rust-miniscript", branch = "develop" }
 
 [features]
 default = ["tor", "lnp", "tokio", "log", "url"]