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

Document the QA process #3607

rowasc opened this issue Jul 10, 2019 · 0 comments


None yet
2 participants
Copy link

commented Jul 10, 2019

Context on user type: The user for this is an OSS contributor that is not very experienced in QA. So maybe they never had a job as a quality analyst or tester but they want to help test this, and we want to be able to explain to them how we do it in platform so they can help. There will be more advanced users of this document too, but the documentation needs to be geared to serve a beginner user first.
Another user type is ourselves (in platform) since we will do the same things as them/follow the same process as part of our efforts to "open source our process" and become more transparent.

The questions that need to be answered are, mainly: "How do I know the platform is working correctly?", "Where do I add more tests for it?" and "How do those tests look like? What do they have?"

  • How to run QA tests: describe how tests are executed, where to go to find them, how to start a new test run, how to mark as pass/fail. This could be complemented with a video where you show it live too.
  • Sample QA scripts show the reader some sample scripts that we have, and explain them.
  • How to write test cases and scripts: describe structure and expectations for writing good test scripts in the context of platform. An example of this would be "Always specify the expected result after a step is executed" .

Related tickets:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.