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

docs: Capturing QA processes, results and artifacts #9020

Closed
thanethomson opened this issue Jul 15, 2022 · 1 comment · May be fixed by #9303
Closed

docs: Capturing QA processes, results and artifacts #9020

thanethomson opened this issue Jul 15, 2022 · 1 comment · May be fixed by #9303
Assignees
Labels
C:docs Component: Documentation stale for use by stalebot

Comments

@thanethomson
Copy link
Contributor

thanethomson commented Jul 15, 2022

As discussed with @josef-widder earlier this week and with @marbar3778 and @cmwaters yesterday, it would be helpful, both to the team and users, to have an easy way to know how different aspects of Tendermint are tested, what tests have been run, and what the results of those tests have been (especially for large-scale testnet executions, and for model-based testing).

Some of the work in #8786 touches on this, and this document for Interchain Security is a good example of the structure of the sort of document aimed for here.

The rough overall structure of such a document for Tendermint would be:

  1. A list of all QA methods used in the project and when they're used.
  2. A table showing concerns vs relevant QA methods for each of those concerns. This could include links to tools or parts of the codebase that perform important/substantial tests (e.g. a link to the model-based tests for the light client).
  3. A QA log with dated entries linking to manually executed testnet/MBT/etc. results. The idea here would not be to capture results from any automated testing, as these are assumed to be available via GitHub.
@thanethomson thanethomson added the C:docs Component: Documentation label Jul 15, 2022
@thanethomson thanethomson self-assigned this Jul 15, 2022
@josef-widder
Copy link
Contributor

josef-widder commented Jul 15, 2022

3. A QA log with dated entries linking to manually executed testnet/MBT/etc. results. The idea here would not be to capture results from any automated testing, as these are assumed to be available via GitHub.

While I would also not list all automated test runs here, it would still be good to capture what automation is in place, and when (or for what version/commit) it was put into place.

Of course it would also be good to note tests that had to be disabled, etc. and why.

@github-actions github-actions bot added the stale for use by stalebot label Mar 27, 2023
@github-actions github-actions bot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C:docs Component: Documentation stale for use by stalebot
Projects
Status: Done/Merged
Development

Successfully merging a pull request may close this issue.

2 participants