Thank you for considering contributing to the SOAP Evaluation framework. This project is stronger due to the wide range of expertise, perspectives, and voices contributed.
We're delighted to have you on board.
By following these contributing guidelines, you are helping to respect the time and efforts the researchers, developers and other participants managing and furthering this open source project have committed. In return, we reciprocate that respect by addressing your issue appropriately, assessing proposed changes and assisting you in submitting pull requests.
We appreciate help with all the following tasks:
- Improving the evaluation framework through worked examples, clarifications and references.
- At this stage, we are not seeking additional products or projects to assess through the SOAP Evaluation.
Our expected standards of behaviour are set out in the project Code of Conduct.
The best place to start is to read through the White Paper.
Here are a couple of friendly tutorials you can include: http://makeapullrequest.com/ and http://www.firsttimersonly.com/
Working on your first Pull Request? You can learn how from this free series, How to Contribute to an Open Source Project on GitHub.
At this point, you're ready to make your changes! Feel free to ask for help; everyone is a beginner at first 😸
If a maintainer asks you to "rebase" your PR, they're saying that a lot of code has changed, and that you need to update your branch so it's easier to merge.
SOAP has been designed with support from researchers across the Australian National University, including computer scientists, cryptographers, legal scholars, epidemiologists, philosophers, data analysts, user researchers, anthropologists, engineers and social scientists. The technical, social, legal and contextual considerations it includes reflect the practicalities - and complexities - of designing and deploying technology solutions. These decisions cannot be left to one discipline, or one frame of reference.
Ultimately, while the contributors to this document span a range of disciplines, we share two common goals: supporting contact tracing during a disease outbreak with responsible, safe technologies where it makes sense to deploy them; and ensuring citizens can trust that any technologies being deployed cannot and will not be used in ways that ultimately harm them.
Ideally, features should be expressed as user stories, with acceptance criteria defined if possible.
Features should be requested by creating an Issue on this project.
The project team will assess the feature request, and may request further information from you.
A member of the project team will review the Issue you have raised and respond either within the Issue, or via return email if you prefer.