Skip to content
This repository has been archived by the owner on Nov 6, 2020. It is now read-only.

docs: Update Readme with TOC, Contributor Guideline. Update Cargo package descriptions #10652

Merged
merged 45 commits into from
Jun 25, 2019
Merged

docs: Update Readme with TOC, Contributor Guideline. Update Cargo package descriptions #10652

merged 45 commits into from
Jun 25, 2019

Conversation

ltfschoen
Copy link
Contributor

  • Update Readme with TOC, Contributor Guideline, and License (similar to Substrate)
  • Update Cargo package descriptions (and add where missing)

@parity-cla-bot
Copy link

It looks like this contributor signed our Contributor License Agreement. 👍

Many thanks,

Parity Technologies CLA Bot

@ltfschoen ltfschoen added the A0-pleasereview 🤓 Pull request needs code review. label May 13, 2019
jam10o-new
jam10o-new reviewed May 13, 2019
View reviewed changes
cli-signer/Cargo.toml Outdated Show resolved Hide resolved
@ltfschoen ltfschoen mentioned this pull request May 13, 2019
Closed
@soc1c soc1c added the M3-docs 📑 Documentation. label May 14, 2019
@soc1c soc1c added this to the 2.6 milestone May 14, 2019
soc1c
soc1c reviewed May 14, 2019
View reviewed changes
CODE_OF_CONDUCT.md Outdated
@@ -0,0 +1,50 @@
# Contributor Covenant Code of Conduct
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you move this to .github/?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, i've removed this and updated the Readme to refer to the existing file that's in the .github/ directory

CONTRIBUTING.md Outdated
@@ -0,0 +1,61 @@
# Contributing
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this can also go in .github/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, i've removed the duplicate, updated the Readme to refer to the existing file in the .github/ directory, and updated the file

soc1c
soc1c suggested changes May 14, 2019
View reviewed changes
Copy link
Contributor

@soc1c soc1c left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hold on, we already have contrib and toc in .github/

@soc1c soc1c added A4-gotissues 💥 Pull request is reviewed and has significant issues which must be addressed. and removed A0-pleasereview 🤓 Pull request needs code review. labels May 14, 2019
@ltfschoen ltfschoen added the A0-pleasereview 🤓 Pull request needs code review. label May 14, 2019
@soc1c soc1c added A8-looksgood 🦄 Pull request is reviewed well. and removed A0-pleasereview 🤓 Pull request needs code review. A4-gotissues 💥 Pull request is reviewed and has significant issues which must be addressed. labels May 14, 2019
@ltfschoen ltfschoen added the A0-pleasereview 🤓 Pull request needs code review. label Jun 6, 2019
tomusdrw
tomusdrw approved these changes Jun 11, 2019
View reviewed changes
Copy link
Collaborator

@tomusdrw tomusdrw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@ltfschoen ltfschoen mentioned this pull request Jun 11, 2019
Closed
6 tasks
@ltfschoen
Copy link
Contributor Author

@dvdplm i've rebased, are you satisfied with the changes?

dvdplm
dvdplm suggested changes Jun 20, 2019
View reviewed changes
Copy link
Collaborator

@dvdplm dvdplm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still a few things I'd like to change.

.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
.github/CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@dvdplm dvdplm merged commit 6022c47 into master Jun 25, 2019
@dvdplm dvdplm added B0-patch-stable 🕷 Pull request should also be back-ported to the stable branch. B1-patch-beta 🕷🕷 and removed A4-gotissues 💥 Pull request is reviewed and has significant issues which must be addressed. labels Jun 25, 2019
@dvdplm dvdplm deleted the luke-readme2 branch June 25, 2019 06:15
dvdplm added a commit that referenced this pull request Jun 25, 2019
@dvdplm
Merge branch 'master' into dp/chore/aura-log-validator-set-in-epoch-m…
8a83bd8 
…anager

* master:
  Treat empty account the same as non-exist accounts in EIP-1052 (#10775)
  docs: Update Readme with TOC, Contributor Guideline. Update Cargo package descriptions (#10652)
  Move Engine::register_client to be before other I/O handler registration (#10767)
dvdplm added a commit that referenced this pull request Jun 25, 2019
@dvdplm
Merge branch 'dp/chore/aura-log-validator-set-in-epoch-manager' into …
41e9f8b 
…dp/fix/prevent-building-block-on-top-of-same-parent

* dp/chore/aura-log-validator-set-in-epoch-manager:
  remove dead code
  Treat empty account the same as non-exist accounts in EIP-1052 (#10775)
  docs: Update Readme with TOC, Contributor Guideline. Update Cargo package descriptions (#10652)
  cleanup
  On second thought non-validators are allowed to report
  Move Engine::register_client to be before other I/O handler registration (#10767)
  cleanup
  Print warnings when using dangerous settings for ValidatorSet (#10733)
  ethcore/res: activate atlantis classic hf on block 8772000 (#10766)
  refactor: Fix indentation (#10740)
  Updated Bn128PairingImpl to use optimized batch pairing  (#10765)
  fix: aura don't add `SystemTime::now()` (#10720)
  Initialize private tx logger only if private tx functionality is enabled (#10758)
  Remove unused code (#10762)
  Remove calls to heapsize (#10432)
s3krit pushed a commit that referenced this pull request Aug 12, 2019
@ltfschoen @s3krit
docs: Update Readme with TOC, Contributor Guideline. Update Cargo pac…
c741254 
…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 <dvdplm@gmail.com>

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

Co-Authored-By: David <dvdplm@gmail.com>

* docs: Rephrase parity-clib/Cargo.toml

Co-Authored-By: David <dvdplm@gmail.com>

* 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 <tomusdrw@users.noreply.github.com>

* 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 <dvdplm@gmail.com>

* docs: Update README.md with simplification

Co-Authored-By: David <dvdplm@gmail.com>

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

Co-Authored-By: David <dvdplm@gmail.com>

* review-fix: Remove hardware wallet from docs

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

* review-fix: Change to test generator title
@s3krit s3krit mentioned this pull request Aug 12, 2019
Merged
s3krit added a commit that referenced this pull request Aug 12, 2019
@s3krit
V2.5.6 stable (#10961)
ff398fe 
  -  Fix cargo audit (#10921)
  - Add support for Energy Web Foundation's new chains (#10957)
  - Kaspersky AV whitelisting (#10919)
  - Avast whitelist script (#10900)
  - Docker images renaming (#10863)
  - Remove excessive warning (#10831)
  - Allow --nat extip:your.host.here.org (#10830)
  - When updating the client or when called from RPC, sleep should mean sleep (#10814)
  - added new ropsten-bootnode and removed old one (#10794)
  - ethkey no longer uses byteorder (#10786)
  - Do not drop the peer with None difficulty (#10772)
  - docs: Update Readme with TOC, Contributor Guideline. Update Cargo package descriptions (#10652)
@s3krit s3krit mentioned this pull request Aug 14, 2019
Merged
s3krit added a commit that referenced this pull request Aug 14, 2019
@s3krit
2.6.1-beta (#10973)
7bfbe41 
  * Add support for Energy Web Foundation's new chains (#10957)                                                                                                                                  
  * Kaspersky AV whitelisting (#10919)                                                                                                                                                           
  * Avast whitelist script (#10900)                                                                                                                                                              
  * Docker images renaming (#10863)                                                                                                                                                              
  * Remove excessive warning (#10831)                                                                                                                                                            
  * Allow --nat extip:your.host.here.org (#10830)                                                                                                                                                
  * When updating the client or when called from RPC, sleep should mean sleep (#10814)                                                                                                           
  * added new ropsten-bootnode and removed old one (#10794)                                                      
  * ethkey no longer uses byteorder (#10786)                                                            
  * docs: Update Readme with TOC, Contributor Guideline. Update Cargo package descriptions (#10652)
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@HCastano HCastano HCastano left review comments

@jam10o-new jam10o-new jam10o-new approved these changes

@soc1c soc1c soc1c approved these changes

@dvdplm dvdplm dvdplm approved these changes

@tomusdrw tomusdrw tomusdrw approved these changes

Assignees
No one assigned
Labels
A0-pleasereview 🤓 Pull request needs code review. B0-patch-stable 🕷 Pull request should also be back-ported to the stable branch. M3-docs 📑 Documentation.
Projects
None yet
Milestone
2.6
Development

Successfully merging this pull request may close these issues.

None yet
7 participants
@ltfschoen @parity-cla-bot @dvdplm @tomusdrw @HCastano @jam10o-new @soc1c