re-start the project

Author: dr-orlovsky

.gitignore

@@ -5,7 +5,7 @@
 # These are backup files generated by rustfmt
 **/*.rs.bk
 
-.idea
+/.idea
 
 *.swp
 

.rustfmt.toml

@@ -1,16 +1,25 @@
+edition = "2024"
+
 max_width = 100
+array_width = 100
+attr_fn_like_width = 100
+comment_width = 100
+chain_width = 100
+fn_call_width = 100
+single_line_if_else_max_width = 100
+
 format_code_in_doc_comments = true
 fn_single_line = true
 format_macro_matchers = true
 format_strings = true
 merge_derives = false
-imports_granularity = "Module"
 overflow_delimited_expr = true
-group_imports = "StdExternalCrate"
+reorder_modules = false
 use_field_init_shorthand = true
 use_try_shorthand = true
 wrap_comments = true
-comment_width = 100
-use_small_heuristics = "Max"
+where_single_line = true
 unstable_features = true
-# license_template_path = "license_header.txt"
+
+imports_granularity = "Module"
+group_imports = "StdExternalCrate"

CODE_OF_CONDUCT.md

@@ -15,5 +15,5 @@ participation.
 Actions within the technical scope of the project (code quality, spamming etc),
 as well as interaction with other maintainers and contributors of course is
 a factor of the access to the project development and lifecycle. The decision in
-these cases will be maid by the project maintainers, with the right of veto or
+these cases will be made by the project maintainers, with the right of veto or
 overriding vote reserved for the original project author, Maxim Orlovsky.

CONTRIBUTING.md

@@ -1,135 +1,196 @@
-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, 
-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, 
-you'll learn.
-
-Communications Channels
------------------------
+Contributing guidelines
+=======================
+
+Contributions are very welcome. When contributing code, please follow these
+simple guidelines.
+
+#### Table Of Contents
+- [Contribution workflow](#contribution-workflow)
+    * [Proposing changes](#proposing-changes)
+    * [Preparing PRs](#preparing-prs)
+    * [Peer review](#peer-review)
+- [Coding conventions](#coding-conventions)
+- [Security](#security)
+- [Testing](#testing)
+- [Going further](#going-further)
+
+Overview
+--------
 
-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/>
+* Before adding any code dependencies, check with the maintainers if this is okay.
+* Write properly formatted comments: they should be English sentences, eg:
 
-Discussion about code base improvements happens in GitHub issues and on pull
-requests.
+        // Return the current UNIX time.
 
-Major projects are tracked [here](https://github.com/orgs/LNP-BP/projects).
-Major milestones are tracked [here](https://github.com/LNP-BP/rust-lnpbp/milestones).
+* Read the DCO and make sure all commits are signed off, using `git commit -s`.
+* Follow the guidelines when proposing code changes (see below).
+* Write properly formatted git commits (see below).
+* Run the tests with `cargo test --workspace --all-features`.
+* Make sure you run `rustfmt` on your code (see below details).
+* Please don't file an issue to ask a question. Each repository - or  
+  GitHub organization has a "Discussions" with Q&A section; please post your
+  questions there. You'll get faster results by using this channel.
 
 Contribution Workflow
 ---------------------
-
 The codebase is maintained using the "contributor workflow" where everyone
 without exception contributes patch proposals using "pull requests". This
 facilitates social contribution, easy testing and peer review.
 
 To contribute a patch, the workflow is a as follows:
 
-  1. Fork Repository
-  2. Create topic branch
-  3. Commit patches
+1. Fork Repository
+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 
+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. 
+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 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.
-
 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 
+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 
+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
---------------------
+### Proposing changes
+
+When proposing changes via a pull-request or patch:
+
+* Isolate changes in separate commits to make the review process easier.
+* Don't make unrelated changes, unless it happens to be an obvious improvement to
+  code you are touching anyway ("boyscout rule").
+* Rebase on `master` when needed.
+* Keep your changesets small, specific and uncontroversial, so that they can be
+  merged more quickly.
+* If the change is substantial or requires re-architecting certain parts of the
+  codebase, write a proposal in English first, and get consensus on that before
+  proposing the code changes.
+
+### Preparing PRs
 
-The main library development happens in the `master` branch. This branch must 
-always compile without errors (using Travis CI). All external contributions are 
+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.
+Prerequisites that a PR must satisfy for merging into the `master` branch:
+* the tip of any PR branch must compile and pass unit tests with no errors, with
+  every feature combination (including compiling the fuzztests) on MSRV, stable
+  and nightly compilers (this is partially automated with CI, so the rule
+  is that we will not accept commits which do not pass GitHub CI);
+* contain all necessary tests for the introduced functional (either as a part of
+  commits, or, more preferably, as separate commits, so that it's easy to
+  reorder them during review and check that the new tests fail without the new
+  code);
+* contain all inline docs for newly introduced API and pass doc tests;
+* be based on the recent `master` tip from the original repository at.
+
+NB: reviewers may run more complex test/CI scripts, thus, satisfying all the
+requirements above is just a preliminary, but not necessary sufficient step for
+getting the PR accepted as a valid candidate PR for the `master` branch.
+
+Additionally, to the `master` branch some repositories may have `develop` branch
+for any experimental developments. This branch may not compile and should not be
+used by any projects depending on the library.
+
+### Writing Git commit messages
+
+A properly formed git commit subject line should always be able to complete the
+following sentence:
+
+     If applied, this commit will _____
+
+In addition, it should be capitalized and *must not* include a period.
+
+For example, the following message is well formed:
+
+     Add support for .gif files
 
-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.
+While these ones are **not**: `Adding support for .gif files`,
+`Added support for .gif files`.
 
+When it comes to formatting, here's a model git commit message[1]:
 
-Peer review
------------
+     Capitalized, short (50 chars or less) summary
+
+     More detailed explanatory text, if necessary.  Wrap it to about 72
+     characters or so.  In some contexts, the first line is treated as the
+     subject of an email and the rest of the text as the body.  The blank
+     line separating the summary from the body is critical (unless you omit
+     the body entirely); tools like rebase can get confused if you run the
+     two together.
+
+     Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
+     or "Fixes bug."  This convention matches up with commit messages generated
+     by commands like git merge and git revert.
+
+     Further paragraphs come after blank lines.
+
+     - Bullet points are okay, too.
+
+     - Typically a hyphen or asterisk is used for the bullet, followed by a
+       single space, with blank lines in between, but conventions vary here.
+
+     - Use a hanging indent.
+
+### 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 
+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]. It is also required to run `cargo fmt` to make the code 
-formatted according to `rustfmt` parameters
-
+Our CI enforces [clippy's](https://github.com/rust-lang/rust-clippy)
+[default linting](https://rust-lang.github.io/rust-clippy/rust-1.52.0/index.html)
+and [rustfmt](https://github.com/rust-lang/rustfmt) formatting defined by rules
+in [.rustfmt.toml](./.rustfmt.toml). The linter should be run with current
+stable rust compiler, while formatter requires nightly version due to the use of
+unstable formatting parameters.
+
+If you use rustup, to lint locally you may run the following instructions:
+
+```console
+rustup component add clippy
+rustup component add fmt
+cargo +stable clippy --workspace --all-features
+cargo +nightly fmt --all
+```
 
 Security
 --------
+Responsible disclosure of security vulnerabilities helps prevent user loss of
+privacy. If you believe a vulnerability may affect other implementations, please
+inform them. Guidelines for a responsible disclosure can be found in
+[SECURITY.md](./SECURITY.md) file in the project root.
 
-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.
-
-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.
-
-Fuzzing is heavily encouraged: feel free to add related material under `fuzz/`
-
-Mutation testing is planned; any contribution there would be warmly welcomed.
+Note that some of our projects are currently considered "pre-production".
+Such projects can be distinguished by the absence of `SECURITY.md`. In such
+cases there are no special handling of security issues; please simply open
+an issue on GitHub.
 
 Going further
 -------------
-
-You may be interested by Jon Atack guide on [How to review Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-review-bitcoin-core-prs.md)
-and [How to make Bitcoin Core PRs](https://github.com/jonatack/bitcoin-development/blob/master/how-to-make-bitcoin-core-prs.md).
-While there are differences between the projects in terms of context and maturity, many
-of the suggestions offered apply to this project.
+You may be interested in Jon Atack guide on
+[How to review Bitcoin Core PRs][Review] and [How to make Bitcoin Core PRs][PR].
+While there are differences between the projects in terms of context and
+maturity, many of the suggestions offered apply to this project.
 
 Overall, have fun :)
+
+[1]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[Review]: https://github.com/jonatack/bitcoin-development/blob/master/how-to-review-bitcoin-core-prs.md
+[PR]: https://github.com/jonatack/bitcoin-development/blob/master/how-to-make-bitcoin-core-prs.md