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

Conformence tests should be well-documented. #446

Closed
3 tasks done
jonathanpberger opened this issue Mar 17, 2023 · 2 comments
Closed
3 tasks done

Conformence tests should be well-documented. #446

jonathanpberger opened this issue Mar 17, 2023 · 2 comments
Assignees

Comments

@jonathanpberger
Copy link
Contributor

jonathanpberger commented Mar 17, 2023

As interchaintest as a library user
I want to be able to discover the conformance package
Because its the standard way to test my ibc integration

Acceptance Criteria

  • a link from the interchaintest README
  • a .md file w/in docs explaining how to use conformance from the interchaintest binary
  • a .md file w/in docs explaining how to use conformance as a library
@jonathanpberger
Copy link
Contributor Author

Docs should be the "hello world" of how you scaffold tests and could include:

  • the convenience method
  • how would you run the "learnIBCTest" in the example

@jtieri
Copy link
Contributor

jtieri commented Nov 2, 2023

I have just opened a PR that will add a doc to interchaintest explaining how to import into other repos as a library to make use of the conformance testing suite here

@jtieri jtieri closed this as completed Nov 2, 2023
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

2 participants