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

[Libp2p] post-merge review improvements #590

Merged
merged 7 commits into from
Mar 18, 2023
Merged

Conversation

bryanchriswhite
Copy link
Contributor

@bryanchriswhite bryanchriswhite commented Mar 16, 2023

Description

Due to circumstances and timing, @Olshansk's final review on #540 came in after merging. This PR implements improvements based on that review feedback.

Issue

Related to #347

Type of change

Please mark the relevant option(s):

  • New feature, functionality or library
  • Bug fix
  • Code health or cleanup
  • Major breaking change
  • Documentation
  • Other

List of changes

  • Correct libp2p module tests
  • Improve libp2p code quality in response to post-merge review feedback

Testing

  • make develop_test
  • LocalNet w/ all of the steps outlined in the README

Required Checklist

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have tested my changes using the available tooling
  • I have updated the corresponding CHANGELOG

If Applicable Checklist

  • I have updated the corresponding README(s); local and/or global
  • I have added tests that prove my fix is effective or that my feature works
  • I have added, or updated, mermaid.js diagrams in the corresponding README(s)
  • I have added, or updated, documentation and mermaid.js diagrams in shared/docs/* if I updated shared/*README(s)

@bryanchriswhite bryanchriswhite added p2p P2P specific changes code health Nice to have code improvement labels Mar 16, 2023
@bryanchriswhite bryanchriswhite self-assigned this Mar 16, 2023
@bryanchriswhite bryanchriswhite marked this pull request as ready for review March 16, 2023 15:21
Copy link
Member

@Olshansk Olshansk left a comment

Choose a reason for hiding this comment

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

LGTM: Just see this one other change as well please: #586 (comment)

@bryanchriswhite bryanchriswhite merged commit c3de3ab into main Mar 18, 2023
@bryanchriswhite bryanchriswhite deleted the chore/libp2p-2-review branch March 18, 2023 15:28
bryanchriswhite added a commit that referenced this pull request Mar 20, 2023
* pokt/main:
  [Libp2p] post-merge review improvements (#590)
  Add call # to devlog4.md title
  chore: add `godoc` comment requirement (#587)
dylanlott pushed a commit that referenced this pull request Mar 24, 2023
## Description

Due to circumstances and timing, @Olshansk's final review on #540 came
in after merging. This PR implements improvements based on that review
feedback.

## Issue

Related to #347

## Type of change

Please mark the relevant option(s):

- [ ] New feature, functionality or library
- [ ] Bug fix
- [x] Code health or cleanup
- [ ] Major breaking change
- [ ] Documentation
- [ ] Other <!-- add details here if it a different type of change -->

## List of changes

- Correct libp2p module tests
- Improve libp2p code quality in response to post-merge review feedback

## Testing

- [ ] `make develop_test`
- [ ]
[LocalNet](https://github.com/pokt-network/pocket/blob/main/docs/development/README.md)
w/ all of the steps outlined in the `README`

## Required Checklist

- [x] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have tested my changes using the available tooling
- [ ] I have updated the corresponding CHANGELOG

### If Applicable Checklist

- [ ] I have updated the corresponding README(s); local and/or global
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I have added, or updated,
[mermaid.js](https://mermaid-js.github.io) diagrams in the corresponding
README(s)
- [ ] I have added, or updated, documentation and
[mermaid.js](https://mermaid-js.github.io) diagrams in `shared/docs/*`
if I updated `shared/*`README(s)
@Poktnews
Copy link

Poktnews commented Apr 5, 2023

/reviewpad summarize

@reviewpad
Copy link

reviewpad bot commented Apr 5, 2023

AI-Generated Pull Request Summary: This pull request includes 7 patches that aim to address code quality issues and test configurations in the libp2p network module. The changes include removing extra lines, improving variable names, updating assertions, updating test configs, updating the changelog, and removing obsolete comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health Nice to have code improvement p2p P2P specific changes
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants