quality-assurance.md

Quality Assurance

Pre-requisites for contributing towards Quality Assurance

1. Join #quality-assurance stream on Zulip. Tag @admins on Zulip to add you under the @qa-team tag.

2. Choose a project

   • Join the respective Zulip stream for that project

3. Setting up the environment of the project

   a. If testing dev environment (stage), you can use deployed versions. You need not setup up the dev environment locally.

   • Mentorship Android
   • Mentorship Flutter
   • Mentorship Backend
   • Volunteer Management System
   • Portal
   • AnitaB.org Open Source Web

   b. If testing PRs, you have to setup the dev environment.

   • Mentorship Android:
     • Dev Env Setup demo
     • Dev Env Setup demo notes
     • PR testing demo
   • Mentorship Flutter:
     • Dev Environemnt Setup demo
     • Dev Environment Setup Notes
     • PR testing demo
   • Mentorship Backend:
     • Dev Env Setup demo - Recording 1, Recording 2, Recording 3
     • Setup Notes
     • Testing PR
   • VMS:
     • Dev env setup demo
     • Setup Notes
   • Portal:
     • Dev env setup instructions
     • Setup Notes
   • AnitaB.org Open Source Web:
     • Setup
   • STEM Diverse TV:
     • Setup

4. Signup on the test management tool TestQuality. Ask on Zulip under #quality-assurance stream tagging @qa-team, to set up your account with the right permission to the project you have chosen.

How to test a PR?

1. Pick a PR from the project you have chosen which has the label Needs Testing.
2. Make sure the PR has 2 code review approvals before you start testing.
3. Go to the Issue that PR is fixing and follow the steps to reproduce that issue while you are under the develop branch.
4. Run the following commands to get to the PR branch, where is the GitHub username of the contributor that submitted the PR:

git clone https://github.com/<contributor>/mentorship-backend/
git checkout <branch-name>

5. Verify the code addition/deletions in the PR.
6. Reproduce the issue and test the fix.
7. Leave a review comment on the PR using the following template:

The changes made in this PR were tested locally. Following are the results:

1. Code review - Done or Not Done

2. All possible responses (positive and negative tests) were tested as below:

   * _Test1 Description_  
     _Screenshot/gif_:  
     _Expected Result_:  
     _Actual Result_:
   * _Test2 Description_  
     _Screenshot/gif_:  
     _Expected Result_:  
     _Actual Result_:  
     ...  
  
3. Additional testcases covered:

   * _Test1 Description_  
     _Screenshot/gif_:  
     _Expected Result_:  
     _Actual Result_:
  
4. Additional Comments:

5. Status of PR Changed to: Needs Review or Ready to Merge.

Quality Assurance Contribution Guidelines

1. Choose a test scenario in the project you’ve chosen and execute it on either the PR or deployed version that is being tested.

   • Open issues under the respective github repo if you find any bugs.

2. Search on TestQuality if the Test Case is already documented. If not, document the testcase on TestQuality under the respective Test Plan and Test Suite. Here is a demo.

   • Have the Test Case reviewed by another QA team member.

3. (Optional) Automate the Test Case, for example: Mentorship Backend User Journey.

4. If you decide to skip step 3, search if there is an existing issue to automate that test case. If not, open an issue with label Quality Assurance.

5. If you automate a Test case make sure you mark it as Automated on TestQuality.