docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac…

…kage descriptions (#10652)

* docs: Update Readme with TOC, Contributor Guide and License sections

* docs: Simplify package descriptions in Readme

* docs: Fix typos

* docs: Update Cargo package configs adding missing descriptions

* fix: Remove machine since was accidental from diff branch. Fix contribting indentation.

* fix: Fix formatting

* remove details snippet since not code and formats badly

* review-fix: Remove duplicate description

* fix dot point formatting

* fix: Add missing description to vm package

* fix: Remove duplicate Code of Conduct and Contributor guidelines

* docs: Update Contributing for consistency with other repos

* docs: Update Readme to link to existing Code of Conduct and Contributor guidelines in .github folder

* refactor: Add missing space

* fix: Fix links to be markdown format

* review-fix: Update CONTRIBUTING.md to link to Parity Ethereum Style Guide

* docs: Fix type in .github/CONTRIBUTING.md

Co-Authored-By: David <[email protected]>

* docs: Fix typo in .github/CONTRIBUTING.md

Co-Authored-By: David <[email protected]>

* docs: Rephrase parity-clib/Cargo.toml

Co-Authored-By: David <[email protected]>

* review-fix: Fix whole paragraph

* review-fix: Add comment to prevent direct pushes to master branch

* review-fix: Change some rules to recommendations

* Update .github/CONTRIBUTING.md

Co-Authored-By: Tomasz Drwięga <[email protected]>

* review-fix: Replace feature reduction with breaking changes dot point

* review-fix: Rephrase what to do when reviewing PR

* review-fix: Update parity-rpc package description and module rustdocs

* docs: Add missing fullstop

* review-fix: Update rustdoc section to show all packages first as default

* review-fix: Rename Parity Util to Parity Core Libraries

* review-fix: Rename readme too for the C bindings name change

* review-fix: Remove some docs since we do not teach the reader Rust

* review-fix: Wrap Parity Ethereum specific packages in a details section

* review-fix: Separate tools that are in this repo vs those that are not

* review-fix: Add link to ethabi on crates.io

* review-fix: Remove unnecessary extra line talking about pushing to master

* review-fix: Remove useless summary of parts of the rust book documentation section

* docs: Update .github/CONTRIBUTING.md to specify two reviewers required

Co-Authored-By: David <[email protected]>

* docs: Update README.md with simplification

Co-Authored-By: David <[email protected]>

* docs: Update README.md renaming to Test Runner instead of just Run

Co-Authored-By: David <[email protected]>

* review-fix: Remove hardware wallet from docs

* review-fix: Remove veto PR section of contributor doc

* review-fix: Change to test generator title

.github/CONTRIBUTING.md

@@ -24,7 +24,42 @@ Also, try to include **steps to reproduce** the issue and expand on the **actual
 
 If you would like to contribute to Parity Ethereum, please **fork it**, fix bugs or implement features, and [propose a pull request](https://github.com/paritytech/parity-ethereum/compare).
 
-Please, refer to the [Coding Guide](https://wiki.parity.io/Coding-guide) in our wiki for more details about hacking on Parity.
+### Labels & Milestones
+
+We use [labels](https://github.com/paritytech/parity-ethereum/labels) to manage PRs and issues and communicate the state of a PR. Please familiarize yourself with them. Furthermore we are organizing issues in [milestones](https://github.com/paritytech/parity-ethereum/milestones). Best way to get started is to a pick a ticket from the current milestone tagged [`easy`](https://github.com/paritytech/parity-ethereum/labels/Q2-easy%20%F0%9F%92%83) and get going, or [`mentor`](https://github.com/paritytech/parity-ethereum/labels/Q1-mentor%20%F0%9F%95%BA) and get in contact with the mentor offering their support on that larger task.
+
+### Rules
+
+There are a few basic ground-rules for contributors (including the maintainer(s) of the project):
+
+* **No pushing directly to the master branch**.
+* **All modifications** must be made in a **pull-request** to solicit feedback from other contributors.
+* Pull-requests cannot be merged before CI runs green and two reviewers have given their approval.
+* Contributors should adhere to the [Parity Ethereum Style Guide](https://wiki.parity.io/Parity-Ethereum-Style-Guide).
+
+### Recommendations
+
+* **Non-master branch names** *should* be prefixed with a short name moniker, followed by the associated Github Issue ID (if any), and a brief description of the task using the format `<GITHUB_USERNAME>-<ISSUE_ID>-<BRIEF_DESCRIPTION>` (e.g. `gavin-123-readme`). The name moniker helps people to inquiry about their unfinished work, and the GitHub Issue ID helps your future self and other developers (particularly those who are onboarding) find out about and understand the original scope of the task, and where it fits into Parity Ethereum [Projects](https://github.com/paritytech/parity-ethereum/projects).
+* **Remove stale branches periodically**
+
+### Preparing Pull Requests
+
+* If your PR does not alter any logic (e.g. comments, dependencies, docs), then it may be tagged [`insubstantial`](https://github.com/paritytech/parity-ethereum/pulls?q=is%3Aopen+is%3Apr+label%3A%22A2-insubstantial+%F0%9F%91%B6%22).
+
+* Once a PR is ready for review please add the [`pleasereview`](https://github.com/paritytech/parity-ethereum/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr+label%3A%22A0-pleasereview+%F0%9F%A4%93%22+) label.
+
+### Reviewing Pull Requests*:
+
+* At least two reviewers are required to review PRs (even for PRs tagged [`insubstantial`](https://github.com/paritytech/parity-ethereum/pulls?q=is%3Aopen+is%3Apr+label%3A%22A2-insubstantial+%F0%9F%91%B6%22)).
+
+When doing a review, make sure to look for any:
+
+* Buggy behavior.
+* Undue maintenance burden.
+* Breaking with house coding style.
+* Pessimization (i.e. reduction of speed as measured in the projects benchmarks).
+* Breaking changes should be carefuly reviewed and tagged as such so they end up in the [changelog](../CHANGELOG.md).
+* Uselessness (i.e. it does not strictly add a feature or fix a known issue).
 
 ## License.
 

README.md

@@ -7,6 +7,24 @@
 <p align="center"><a href="https://gitlab.parity.io/parity/parity-ethereum/commits/master" target="_blank"><img src="https://gitlab.parity.io/parity/parity-ethereum/badges/master/build.svg" /></a>
 <a href="https://www.gnu.org/licenses/gpl-3.0.en.html" target="_blank"><img src="https://img.shields.io/badge/license-GPL%20v3-green.svg" /></a></p>
 
+## Table of Contents
+
+1. [Description](#chapter-001)
+2. [Technical Overview](#chapter-002)
+3. [Building](#chapter-003)<br>
+  3.1 [Building Dependencies](#chapter-0031)<br>
+  3.2 [Building from Source Code](#chapter-0032)<br>
+  3.3 [Simple One-Line Installer for Mac and Linux](#chapter-0033)<br>
+  3.4 [Starting Parity Ethereum](#chapter-0034)
+4. [Documentation](#chapter-004)
+5. [Toolchain](#chapter-005)
+6. [Community](#chapter-006)
+7. [Contributing](#chapter-007)
+8. [License](#chapter-008)
+
+
+## 1. Description <a id="chapter-001"></a>
+
 **Built for mission-critical use**: Miners, service providers, and exchanges need fast synchronisation and maximum uptime. Parity Ethereum provides the core infrastructure essential for speedy and reliable services.
 
 - Clean, modular codebase for easy customisation
@@ -15,7 +33,7 @@
 - Synchronise in hours, not days with Warp Sync
 - Modular for light integration into your service or product
 
-## Technical Overview
+## 2. Technical Overview <a id="chapter-002"></a>
 
 Parity Ethereum's goal is to be the fastest, lightest, and most secure Ethereum client. We are developing Parity Ethereum using the sophisticated and cutting-edge **Rust programming language**. Parity Ethereum is licensed under the GPLv3 and can be used for all your Ethereum needs.
 
@@ -25,7 +43,9 @@ If you run into problems while using Parity Ethereum, check out the [wiki for do
 
 Parity Ethereum's current beta-release is 2.1. You can download it at [the releases page](https://github.com/paritytech/parity-ethereum/releases) or follow the instructions below to build from source. Please, mind the [CHANGELOG.md](CHANGELOG.md) for a list of all changes between different versions.
 
-## Build Dependencies
+## 3. Building <a id="chapter-003"></a>
+
+### 3.1 Build Dependencies <a id="chapter-0031"></a>
 
 Parity Ethereum requires **latest stable Rust version** to build.
 
@@ -58,7 +78,7 @@ Once you have `rustup` installed, then you need to install:
 
 Make sure that these binaries are in your `PATH`. After that, you should be able to build Parity Ethereum from source.
 
-## Build from Source Code
+### 3.2 Build from Source Code <a id="chapter-0032"></a>
 
 ```bash
 # download Parity Ethereum code
@@ -95,7 +115,7 @@ or
 $ git checkout beta
 ```
 
-## Simple One-Line Installer for Mac and Linux
+### 3.3 Simple One-Line Installer for Mac and Linux <a id="chapter-0033"></a>
 
 ```bash
 bash <(curl https://get.parity.io -L)
@@ -107,9 +127,9 @@ The one-line installer always defaults to the latest beta release. To install a
 bash <(curl https://get.parity.io -L) -r stable
 ```
 
-## Start Parity Ethereum
+### 3.4 Starting Parity Ethereum <a id="chapter-0034"></a>
 
-### Manually
+#### Manually
 
 To start Parity Ethereum manually, just run
 
@@ -119,7 +139,7 @@ $ ./target/release/parity
 
 so Parity Ethereum begins syncing the Ethereum blockchain.
 
-### Using `systemd` service file
+#### Using `systemd` service file
 
 To start Parity Ethereum as a regular user using `systemd` init:
 
@@ -128,17 +148,203 @@ To start Parity Ethereum as a regular user using `systemd` init:
 2. Copy release to bin folder, write `sudo install ./target/release/parity /usr/bin/parity`
 3. To configure Parity Ethereum, write a `/etc/parity/config.toml` config file, see [Configuring Parity Ethereum](https://paritytech.github.io/wiki/Configuring-Parity) for details.
 
-## Parity Ethereum toolchain
+## 4. Documentation <a id="chapter-004"></a>
+
+Official website: https://parity.io
+
+Be sure to [check out our wiki](https://wiki.parity.io) for more information.
+
+### Viewing documentation for Parity Ethereum packages
+
+You can generate documentation for Parity Ethereum Rust packages that automatically opens in your web browser using [rustdoc with Cargo](https://doc.rust-lang.org/rustdoc/what-is-rustdoc.html#using-rustdoc-with-cargo) (of the The Rustdoc Book), by running the the following commands:
+
+* **All** packages
+  ```
+  cargo doc --open
+  ```
+
+* Specific package
+  ```
+  cargo doc --package <spec> --open
+  ```
+
+Replacing `<spec>` with one of the following from the details section below (i.e. `cargo doc --package parity-ethereum --open`):
+
+<details><p>
+
+* Parity Ethereum (EthCore) Client Application
+  ```bash
+  parity-ethereum
+  ```
+* Parity Ethereum Account Management, Key Management Tool, and Keys Generator
+  ```bash
+  ethcore-accounts, ethkey-cli, ethstore, ethstore-cli
+  ```
+* Parity Chain Specification
+  ```bash
+  chainspec
+  ```
+* Parity CLI Signer Tool & RPC Client
+  ```bash
+  cli-signer parity-rpc-client
+  ```
+* Parity Ethereum Ethash & ProgPoW Implementations
+  ```bash
+  ethash
+  ```
+* Parity (EthCore) Library
+  ```bash
+  ethcore
+  ```
+  * Parity Ethereum Blockchain Database, Test Generator, Configuration,
+Caching, Importing Blocks, and Block Information
+    ```bash
+    ethcore-blockchain
+    ```
+  * Parity Ethereum (EthCore) Contract Calls and Blockchain Service & Registry Information
+    ```bash
+    ethcore-call-contract
+    ```
+  * Parity Ethereum (EthCore) Database Access & Utilities, Database Cache Manager
+    ```bash
+    ethcore-db
+    ```
+  * Parity Ethereum Virtual Machine (EVM) Rust Implementation
+    ```bash
+    evm
+    ```
+  * Parity Ethereum (EthCore) Light Client Implementation
+    ```bash
+    ethcore-light
+    ```
+  * Parity Smart Contract based Node Filter, Manage Permissions of Network Connections
+    ```bash
+    node-filter
+    ```
+  * Parity Private Transactions
+    ```bash
+    ethcore-private-tx
+    ```
+  * Parity Ethereum (EthCore) Client & Network Service Creation & Registration with the I/O Subsystem
+    ```bash
+    ethcore-service
+    ```
+  * Parity Ethereum (EthCore) Blockchain Synchronization
+    ```bash
+    ethcore-sync
+    ```
+  * Parity Ethereum Common Types
+    ```bash
+    common-types
+    ```
+  * Parity Ethereum Virtual Machines (VM) Support Library
+    ```bash
+    vm
+    ```
+  * Parity Ethereum WASM Interpreter
+    ```bash
+    wasm
+    ```
+  * Parity Ethereum WASM Test Runner
+    ```bash
+    pwasm-run-test
+    ```
+  * Parity EVM Implementation
+    ```bash
+    evmbin
+    ```
+  * Parity Ethereum IPFS-compatible API
+    ```bash
+    parity-ipfs-api
+    ```
+  * Parity Ethereum JSON Deserialization
+    ```bash
+    ethjson
+    ```
+  * Parity Ethereum State Machine Generalization for Consensus Engines
+    ```bash
+    parity-machine
+    ```
+* Parity Ethereum (EthCore) Miner Interface
+  ```bash
+  ethcore-miner parity-local-store price-info ethcore-stratum using_queue
+  ```
+* Parity Ethereum (EthCore) Logger Implementation
+  ```bash
+  ethcore-logger
+  ```
+* C bindings library for the Parity Ethereum client
+  ```bash
+  parity-clib
+  ```
+* Parity Ethereum JSON-RPC Servers
+  ```bash
+  parity-rpc
+  ```
+* Parity Ethereum (EthCore) Secret Store
+  ```bash
+  ethcore-secretstore
+  ```
+* Parity Updater Service
+  ```bash
+  parity-updater parity-hash-fetch
+  ```
+* Parity Core Libraries (Parity Util)
+  ```bash
+  ethcore-bloom-journal blooms-db dir eip-712 fake-fetch fastmap fetch ethcore-io
+  journaldb keccak-hasher len-caching-lock macros memory-cache memzero
+  migration-rocksdb ethcore-network ethcore-network-devp2p panic_hook
+  patricia-trie-ethereum registrar rlp_compress rlp_derive parity-runtime stats
+  time-utils triehash-ethereum unexpected parity-version
+  ```
+* Parity Whisper Protocol Implementation
+  ```bash
+  parity-whisper whisper-cli
+  ```
+
+</p></details>
+
+### Contributing to documentation for Parity Ethereum packages
+
+[Document source code](https://doc.rust-lang.org/1.9.0/book/documentation.html) for Parity Ethereum packages by annotating the source code with documentation comments.
+
+Example (generic documentation comment):
+```markdown
+/// Summary
+///
+/// Description
+///
+/// # Panics
+///
+/// # Errors
+///
+/// # Safety
+///
+/// # Examples
+///
+/// Summary of Example 1
+///
+/// ```rust
+/// // insert example 1 code here for use with documentation as tests
+/// ```
+///
+```
+
+## 5. Toolchain <a id="chapter-005"></a>
 
 In addition to the Parity Ethereum client, there are additional tools in this repository available:
 
-- [evmbin](https://github.com/paritytech/parity-ethereum/blob/master/evmbin/) - EVM implementation for Parity Ethereum.
-- [ethabi](https://github.com/paritytech/ethabi) - Parity Ethereum function calls encoding.
-- [ethstore](https://github.com/paritytech/parity-ethereum/blob/master/accounts/ethstore) - Parity Ethereum key management.
-- [ethkey](https://github.com/paritytech/parity-ethereum/blob/master/accounts/ethkey) - Parity Ethereum keys generator.
-- [whisper](https://github.com/paritytech/parity-ethereum/blob/master/whisper/) - Implementation of Whisper-v2 PoC.
+- [evmbin](./evmbin) - Parity Ethereum EVM Implementation.
+- [ethstore](./accounts/ethstore) - Parity Ethereum Key Management.
+- [ethkey](./accounts/ethkey) - Parity Ethereum Keys Generator.
+- [whisper](./whisper) - Parity Ethereum Whisper-v2 PoC Implementation.
 
-## Join the chat!
+The following tool is available in a separate repository:
+- [ethabi](https://github.com/paritytech/ethabi) - Parity Ethereum Encoding of Function Calls. [Docs here](https://crates.io/crates/ethabi)
+
+## 6. Community <a id="chapter-006"></a>
+
+### Join the chat!
 
 Questions? Get in touch with us on Gitter:
 [![Gitter: Parity](https://img.shields.io/badge/gitter-parity-4AB495.svg)](https://gitter.im/paritytech/parity)
@@ -149,8 +355,14 @@ Questions? Get in touch with us on Gitter:
 Alternatively, join our community on Matrix:
 [![Riot: +Parity](https://img.shields.io/badge/riot-%2Bparity%3Amatrix.parity.io-orange.svg)](https://riot.im/app/#/group/+parity:matrix.parity.io)
 
-## Documentation
+## 7. Contributing <a id="chapter-007"></a>
 
-Official website: https://parity.io
+An introduction has been provided in the ["So You Want to be a Core Developer" presentation slides by Hernando Castano](http://tiny.cc/contrib-to-parity-eth). Additional guidelines are provided in [CONTRIBUTING](./.github/CONTRIBUTING.md).
 
-Be sure to [check out our wiki](https://wiki.parity.io) for more information.
+### Contributor Code of Conduct
+
+[CODE_OF_CONDUCT](./.github/CODE_OF_CONDUCT.md)
+
+## 8. License <a id="chapter-008"></a>
+
+[LICENSE](./LICENSE)

accounts/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-description = "Account management for Parity Ethereum"
+description = "Parity Ethereum Account Management"
 homepage = "http://parity.io"
 license = "GPL-3.0"
 name = "ethcore-accounts"

accounts/ethkey/Cargo.toml

@@ -1,4 +1,5 @@
 [package]
+description = "Parity Ethereum Keys Generator"
 name = "ethkey"
 version = "0.3.0"
 authors = ["Parity Technologies <[email protected]>"]

accounts/ethkey/README.md

@@ -5,7 +5,7 @@ Parity Ethereum keys generator.
 ### Usage
 
 ```
-Parity Ethereum keys generator.
+Parity Ethereum Keys Generator.
   Copyright 2015-2019 Parity Technologies (UK) Ltd.
 
 Usage:

accounts/ethkey/cli/Cargo.toml

@@ -1,4 +1,5 @@
 [package]
+description = "Parity Ethereum Keys Generator CLI"
 name = "ethkey-cli"
 version = "0.1.0"
 authors = ["Parity Technologies <[email protected]>"]

accounts/ethstore/Cargo.toml

@@ -1,4 +1,5 @@
 [package]
+description = "Parity Ethereum Key Management"
 name = "ethstore"
 version = "0.2.1"
 authors = ["Parity Technologies <[email protected]>"]

accounts/ethstore/cli/Cargo.toml

@@ -1,4 +1,5 @@
 [package]
+description = "Parity Ethereum Key Management CLI"
 name = "ethstore-cli"
 version = "0.1.1"
 authors = ["Parity Technologies <[email protected]>"]