Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 5.46 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 5.46 KB

Contributing to the Africa Internet Measurements Project

Thank you once again for your interest in joining this project! 👏🏾 🎊 🎉

The Broadband Performance and Internet Measurements project aims to build a portal and work with researchers to collect and analyse Internet measurements data so that regulators and policy makers can develop policy that will help Internet Service Providers to improve service delivery and end users to make informed choices. Please see more information in the project README.md.

This document (CONTRIBUTING.md) is a set of guidelines for contributing to the project on GitHub. These are guidelines, not rules, to make it easy for anyone to get involved.

Participant guidelines

Please take a look at the project Code of Conduct, which outlines our expectations for participants within the project.

What we are working on

To get started, take a look at the issues in our milestones. Find an interesting issue to contribute to.

Since many people use the Internet, anyone can be part of the project.

  • End users can contribute by downloading one of the many speed test applications and testing their broadband speeds. I am currently working with Netradar, SpeedChecker, Princeton University’s Speed Test. These vendors have generously agreed to provide raw data to Research ICT Africa, containing anonymous tests conducted in Africa for the period 2013 - 2018. Network engineers are also welcome to conduct tests on their networks and share findings.
  • Researchers can help with finding relevant documentation about the subject matter, especially in the region. This includes journals, articles, publications, portals, and other case studies that we can learn from.
  • Data visualisation experts can help interpret the data in a way that makes sense to different audiences: end users, regulators, service providers. Maps, graphs, charts are preferable, but other tools are welcome.
  • Open data experts or web designers can give guidance on how to develop an interactive and open data portal that will contain this information. Take a look at this presentation to see some sample results.
  • Anyone interested in Internet measurements is welcome to give guidance or work with us to build a community of people interested in the subject and to develop a solution.

How to submit changes

Once you have identified an issue that you would like to contribute to, please feel free to make a change to the project repository! To do this,

  1. Fork this repository. This makes your own version of this project you can edit and use.
  2. Make your changes. This can be done in your GitHub interface or on your local machine.
  3. Once you are happy with your changes, submit a pull request. This opens a discussion around your project and lets the project lead know you are proposing changes.

New to open source? Check out this free series: How to Contribute to an Open Source Project on GitHub.

How to report bugs

Please report bugs and lookout for any issues that can cause problems for the project. Bugs, requests and questions can be reported in our issue tracker. We shall be updating this document with details about reporting bugs.

Communication channels

Please feel free to always suggest new ideas, edits, project improvements, etc. to sarahk(at)mozillafoundation(dot)org or skiden(at)gmail(dot)com. We have a Gitter chat room which you can join for further disucssion. If you have suggestions about better communication channels, do let us know! Also feel free to connect through Twitter (@MsKiden)!

78500beaafd3bed2f2c63a13bbd703dfa990a175

Acknowledgements

We would like to thank everyone who contributed to the project from inception. First to Abby Cabunoc Mayes, Zannah and the Mozilla Open Leaders Team, Bonface Ochieng for mentoring the project and Enrico Calandro (and the Research ICT Africa team) for overall supervision during the Ford-Mozilla Open Web Fellowship experience.

Much appreciation goes to the following people for contributing before, during and after the #MozSprint:

  • Sight Ampamya
  • Isaac Maposa
  • Rushmore Mushambi
  • Alex Mwotil
  • Mary Anna Sadimba
  • Carlos Nyanga
  • Ravindu Perera
  • Catherine Kang'ethe

Mary, Carlos and Ravindu offered to build a portal containing service providers. They also agreed to continue working on the project after #MozSprint.