Skip to content
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.

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

Main readme modifications for v0.1.0 #598

Merged
merged 5 commits into from
Feb 4, 2021
Merged

Main readme modifications for v0.1.0 #598

merged 5 commits into from
Feb 4, 2021

Conversation

adizere
Copy link
Member

@adizere adizere commented Feb 2, 2021

Closes: #574
Rendered

There are two todos left:

  • correct links to crates.io and docs.io for relayer & relayer-cli
  • Link to the relayer guide

Description


For contributor use:

  • Updated the Unreleased section of CHANGELOG.md with the issue.
  • If applicable: Unit tests written, added test to CI.
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Updated relevant documentation (docs/) and code comments.
  • Re-reviewed Files changed in the Github PR explorer.

@adizere adizere mentioned this pull request Feb 2, 2021
13 tasks
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Romain Ruetschi <romain@informal.systems>
@codecov-io
Copy link

codecov-io commented Feb 2, 2021

Codecov Report

Merging #598 (e8b0efd) into master (b1b37f5) will increase coverage by 31.4%.
The diff coverage is 65.2%.

Impacted file tree graph

@@            Coverage Diff            @@
##           master    #598      +/-   ##
=========================================
+ Coverage    13.6%   45.1%   +31.4%     
=========================================
  Files          69     143      +74     
  Lines        3752    9408    +5656     
  Branches     1374       0    -1374     
=========================================
+ Hits          513    4249    +3736     
- Misses       2618    5159    +2541     
+ Partials      621       0     -621     
Impacted Files Coverage Δ
...application/ics20_fungible_token_transfer/error.rs 0.0% <0.0%> (ø)
...pplication/ics20_fungible_token_transfer/events.rs 0.0% <ø> (ø)
...ion/ics20_fungible_token_transfer/msgs/transfer.rs 0.0% <0.0%> (ø)
modules/src/events.rs 0.0% <0.0%> (ø)
modules/src/ics02_client/error.rs 100.0% <ø> (ø)
modules/src/ics03_connection/error.rs 100.0% <ø> (+66.6%) ⬆️
modules/src/ics03_connection/handler/verify.rs 60.0% <ø> (ø)
modules/src/ics03_connection/msgs.rs 100.0% <ø> (+78.0%) ⬆️
modules/src/ics03_connection/msgs/conn_open_ack.rs 84.4% <ø> (ø)
...les/src/ics03_connection/msgs/conn_open_confirm.rs 80.6% <ø> (ø)
... and 270 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 03cb9ca...fe2a2ee. Read the comment docs.

README.md Outdated Show resolved Hide resolved
@@ -56,8 +54,7 @@ of smaller incremental changes, in the form of small PRs that can be merged
quickly. This helps manage the load for reviewers and reduces the likelihood
that PRs will sit open for longer.

![Contributing
flow](https://github.com/tendermint/tendermint/blob/v0.33.6/docs/imgs/contributing.png)
![Contributing flow](https://github.com/tendermint/tendermint/blob/v0.33.6/docs/imgs/contributing.png?raw=true)
Copy link
Member

Choose a reason for hiding this comment

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

👍

README.md Outdated Show resolved Hide resolved
Co-authored-by: Romain Ruetschi <romain@informal.systems>
@adizere adizere mentioned this pull request Feb 3, 2021
20 tasks
Copy link
Collaborator

@ancazamfir ancazamfir left a comment

Choose a reason for hiding this comment

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

Looks good! Thanks Adi!

@adizere adizere merged commit 605b755 into master Feb 4, 2021
@adizere adizere deleted the adi/v010_readme branch February 4, 2021 10:26
hu55a1n1 pushed a commit to hu55a1n1/hermes that referenced this pull request Sep 13, 2022
* Main readme, mostly

* Apply suggestions from code review

Co-authored-by: Romain Ruetschi <romain@informal.systems>

* Guide todo removed.

* Apply suggestions from code review

Co-authored-by: Romain Ruetschi <romain@informal.systems>

* Update license year

Co-authored-by: Romain Ruetschi <romain@informal.systems>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Incorrect, inconsistent and out of date documentation in .md files
4 participants