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

Hardhat Developer Workflow Tutorial #524

Merged
merged 68 commits into from Mar 15, 2023
Merged

Hardhat Developer Workflow Tutorial #524

merged 68 commits into from Mar 15, 2023

Conversation

themacexpert
Copy link
Contributor

@themacexpert themacexpert commented Jan 26, 2023

Description

Adds Hardhat Developer Workflow Tutorial for the Tutorials section.
@eshaben you're coauthor because a lot of the hardhat stuff is re-used snippets

https://purestake.atlassian.net/browse/MD-1138 is the ticket for the translations

Checklist

  • If this requires translations for the moonbeam-docs-cn repo, I have created a ticket for the translations in Jira
  • If pages have been moved around, I have created an additional PR in moonbeam-mkdocs to update redirects
  • If pages have been moved around, I have run the move-pages.py script to move the pages and update the image paths on the chinese repo
    • After the script has been run, I have created an additional PR in moonbeam-docs-cn
  • If images have been added, I have run the compress-images.py script to compress the images.
  • If variables (in variables.yml) need to be updated (such as a name change), I have updated the moonbeam-docs-cn repo to use the new variables
  • If this page requires a disclaimer, I have added one

Corresponding PRs

Please link to any corresponding PRs here.

After Translation Requirements

  • Will need to create PR in moonbeam-docs repo to remove images
  • Will need to create PR in moonbeam-docs repo to remove variables
  • Will need to create PR in moonbeam-mkdocs repo to add redirects for Chinese site
  • No additional PRs are required after the translations are done

Items to be Updated

Please list any of the items that will need to be added or deleted after the translations are done here.

Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Lots of ground to cover with this tutorial! 😅 I really like how in-depth you went with the testing sections!

To try and align this with the Foundry and Truffle guides, the testing section needs to come before deployment and verification. In addition, there needs to be some sort of like TestNet to MainNet progression. So, with the other guides there are two deployment sections: one for Moonbase Alpha and one for Moonbeam MainNet and I think that is what is needed here so the deployment and verification happens on both networks. I would also reference those tutorials and the section headers to try and closely align them where it makes sense.

Are fixtures just kind of like beforeEach() in Mocha, where setup happens for the tests? Or is there more to it? Because I feel like I was expecting there to be more to it but in the examples it just seems like general setup

tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
@themacexpert
Copy link
Contributor Author

@eshaben Thank you for the detailed feedback, I think everything is sorted now 😄

.snippets/text/hardhat/hardhat-configuration-file.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
tutorials/hardhat-tutorial.md Outdated Show resolved Hide resolved
@eshaben
Copy link
Contributor

eshaben commented Feb 20, 2023

We're almost there! Left a few comments... but in general I think it would be helpful to do a final walk through of the tutorial yourself to make sure it flows 🙂

Base automatically changed from tutorials to master February 24, 2023 15:24
themacexpert and others added 12 commits March 8, 2023 17:47
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Co-authored-by: Erin Shaben <eshaben@icloud.com>
Copy link
Contributor

@eshaben eshaben left a comment

Choose a reason for hiding this comment

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

Awesome!! Nice work on this one!! 🚀

LGTM ✨ 🚢

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.

None yet

2 participants