Contributing to Open Source in Quality Assurance
Did you know you can contribute to Open Source with Quality Assurance?
Usually while building software, there is some component of quality assurance or testing involved, so that also applies to open source projects. When I think of quality assurance of a project I think of testing in general, which includes writing unit tests, integration tests, manual testing, performance testing, documenting test scenarios, …
Contributing to Quality Assurance (QA) helps to ensure the overall quality of the project since it can help to detect bugs early and faults in how the feature was implemented.
Ways to contribute
So here are some examples of how to contribute to Quality Assurance of an open source project:
- Test manually a pull request code before it gets accepted to be merged, to confirm the code is working as expected. Be creative! Try to come up with test cases for the feature being implemented that perhaps the author of the pull request did not think of. Examples: testing REST API, testing bottom navigation bug in android app.
- Test the deployed version of the app and report bugs found by creating issues describing them! Provide as much information as you can so that maintainers and other contributors can confirm the bug, and also for developers to have the necessary context to look for a solution for it.
- Write tests to improve test coverage of the project. These could be unit, integration, user interface, automation tests… Sometimes also, there could be enough code coverage, but some edge cases for a feature might not be covered in those. So be creative!
- Reproduce bugs already reported through issues and add more context or information to those if you think it’s missing. You can help maintainers confirm if a bug was properly reported and makes sense.
- Write documentation about test cases for the project. This can help new contributors learn how to use the project, and what are some use cases for it. Also can help other testers, do more testing and cover more scenarios. Example: quality assurance test cases for mentorship-backend.
- Help automate tasks on CI/CD pipeline as enforcing coding style in code, run tests for the project, so that pipeline fails and signals to contributors and maintainers of the code changes of a pull request are up to standards.
Resources to learn more about Quality Assurance
There are 2 resources that come to my mind with regards to learning more about Quality Assurance.
- Test Automation University — https://testautomationu.applitools.com/ where you can learn about Test automation specifically.
- FreeCodeCamp has a certification for Quality Assurance https://www.freecodecamp.org/
I would love to know more resources, so if you know more, let me know in the comments :)
Process at AnitaB.org Open Source community
When working on my Google Summer of Code project back in 2018, I tried to come with ways for other open source contributors, to contribute to the project by testing it. I asked for help in the community for people to test the application and report bugs found by creating issues. Here’s an example of a bug reported where user registration was possible by sending empty values for certain required fields.
When contributing to Open Data Kit, I noticed that maintainers had a step while reviewing code, of verifying if my change was working on multiple Android versions. This inspired me to incorporate such steps in our community as well. These days at AnitaB.org Open Source we have this step as part of our Open Source workflow, in particular of the Pull Request lifecycle.
Our work related to QA includes:
- A guide to contributing to Quality Assurance in our projects;
- We also have a PR test report template we encourage our contributors to use when testing a PR;
- Once we have 2 approvals, we label the issue with “Status: Needs Testing” and wait for someone, other than the author, to run the PR code (or test the live app if there is a deployed version of the PR) and test what was implemented. In success, we label the issue with “Status: Ready to Merge”, in failure we re-evaluate the PR with the contributor;
- We started exploring a test management tool called TestQuality to help us document test scenarios we already know and tested before;
- We have a dedicated channel #quality-assurance on Zulip for general discussion around QA;
- Writing automated tests, which includes UI tests and unit tests, user journey tests, …
- We have deployed versions of some of our projects, which allows contributors to test the app, without running the app in their development environments. We also have apk artifacts being built through GitHub Actions for one of our Android apps being developed.
As per our experience in the community, people who were joining us were mostly interested in contributing as a developer, but eventually got interested and helped with this type of contribution. By learning how to test a project, you also learn how the project works. This can be an easy path to start contributing and getting familiar with the project and its codebase.
A huge thank you to Roshni Pattath who has been an advocate and mentor for quality assurance within the AnitaB.org Open Source community. I’ve learned so much from her. Also for helping me review this post.