Skip to content
This repository has been archived by the owner on Sep 30, 2024. It is now read-only.

Update Repo Documentation, archive older components, CI e2e tests #257

Merged
merged 4 commits into from
Jul 20, 2024

Conversation

jacque006
Copy link
Contributor

@jacque006 jacque006 commented Jul 17, 2024

What is this PR doing?

  • Update repo documentation to assist in contributions & usage
  • Move older work to archive directory
  • Add plugins hardhat integration
  • Smaller updates & fixes, see commits

How can these changes be manually tested?

👀 , GitHub Actions CI pipeline should handle the rest

Does this PR resolve or contribute to any issues?

Resolves #211

Checklist

  • I have manually tested these changes
  • Post a link to the PR in the group chat

Guidelines

  • If your PR is not ready, mark it as a draft
  • The resolve conversation button is for reviewers, not authors
    • (But add a 'done' comment or similar)

TODO

  • Break up plugin's contracts to appropriate subdirectories
  • Extend & finish updating plugins documentation

@jacque006 jacque006 requested a review from JohnGuilding July 17, 2024 14:37
Add hardhat integration tests to github actions run.
Add/update numerous READMEs for packages.
Deprecate remaining ZKEmail recovery modules in favor of new one.
Remove circom submodule.
Increase wait time for plugins test servers.
Update plugins README.
Wrap deploy_all script's wallet with nonce manager.
@jacque006 jacque006 marked this pull request as ready for review July 18, 2024 12:32
@jacque006 jacque006 changed the title Update Repo Documentation Update Repo Documentation, archive older components, CI e2e tests Jul 18, 2024
Copy link
Contributor

@JohnGuilding JohnGuilding left a comment

Choose a reason for hiding this comment

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

Look great, merging then can make any further changes in follow ups :)

  1. Do you think we should get rid of the sdk?
  2. I'm still skeptical the joint foundry and hardhat project is a good setup for contributions, what do you think about breaking it up or changing something there?
  3. What do you think about splitting more things into different repos in further updates? I've been leaning against the monorepo pattern for wax, as not sure if it's giving us any big benefits, and makes it more difficult for people to understand what is going on in the repo

@JohnGuilding JohnGuilding merged commit 0e82c89 into main Jul 20, 2024
4 checks passed
@JohnGuilding JohnGuilding deleted the update-repo-docs branch July 20, 2024 15:32
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update WAX READMEs
2 participants