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 more documentation for e2e tests on Gaia #2903

Open
Tracked by #2902
p-offtermatt opened this issue Jan 23, 2024 · 0 comments
Open
Tracked by #2902

Add more documentation for e2e tests on Gaia #2903

p-offtermatt opened this issue Jan 23, 2024 · 0 comments
Assignees
Labels
S: Productivity Productivity: Developer tooling, infrastructure improvements enabling future growth scope: docs Improvements or additions to documentation scope: testing Code review, testing, making sure the code is following the specification.

Comments

@p-offtermatt
Copy link
Contributor

p-offtermatt commented Jan 23, 2024

Problem

We should have more documentation for how to work with the e2e tests for Gaia.

Closing criteria

There is more documentation for the e2e tests.

Problem details

We are missing documentation that makes it easy to work with the e2e tests.
We want people with little prior exposure to the Gaia repo itself to be able to add a new, simple test case in a reasonable time frame, and having good documentation would help.

I see two ways to tackle this:

  1. High-level guidelines, akin to docs: Add guidelines for e2e tests interchain-security#1466
  2. A step-by-step tutorial that goes through the motions of adding a simple test case

I think either or both could be useful.
In case of 2), it would be an extra bonus that the easiest way to write such a tutorial is probably to actually add a new test and take notes while doing it, so we'd get an extra test out of it.

@p-offtermatt p-offtermatt added scope: docs Improvements or additions to documentation scope: testing Code review, testing, making sure the code is following the specification. labels Jan 23, 2024
@p-offtermatt p-offtermatt changed the title Add step-by-step tutorial for adding an e2e test to Gaia Add more documentation for adding an e2e test to Gaia Jan 23, 2024
@p-offtermatt p-offtermatt changed the title Add more documentation for adding an e2e test to Gaia Add more documentation for e2e tests on Gaia Jan 23, 2024
@p-offtermatt p-offtermatt added the S: Productivity Productivity: Developer tooling, infrastructure improvements enabling future growth label Jan 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S: Productivity Productivity: Developer tooling, infrastructure improvements enabling future growth scope: docs Improvements or additions to documentation scope: testing Code review, testing, making sure the code is following the specification.
Projects
Status: 📥 F2: Todo
Development

No branches or pull requests

2 participants