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

Add running tests to the README #436

Open
PatrickAlphaC opened this issue May 2, 2024 · 0 comments
Open

Add running tests to the README #436

PatrickAlphaC opened this issue May 2, 2024 · 0 comments

Comments

@PatrickAlphaC
Copy link

PatrickAlphaC commented May 2, 2024

I'm not sure how to run tests on this repo. Could we add a test key to the package.json, or at least tell users instructions are in each README.

To add more context, we need to update the CONTRIBUTING.md file entirely. It's not clear how this repo fits together. Is each folder in this repo self-contained? Can I even run the whole test suite across each directory?

The following folders likely need a README.md:

  1. l2-contracts
    I was unable to get this test suite to pass.

  2. l1-contracts
    I was unable to get this test suite to pass.

  3. system-contracts
    The system-contracts folder has a good README.md. I was able to successfully run and execute tests.

With how to run their test suite, and what the folders are intended to do/be.

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

No branches or pull requests

1 participant