Skip to content

Before You Start

Jump to bottom
Matt Sayre edited this page Jul 1, 2019 · 30 revisions

Thank You!!!

First this, thank you for wanting to help on this project and bringing your skills to support it. We're a grass-roots effort of developers primarily based in Eugene, Oregon. Please read the contribution document before opening issues or pull requests.

About

SpeedUpAmerica aims to provide on the ground truth about the Internet in America. Our national broadband map provides transparency: real Internet speeds received, actual prices paid, and level of service experienced.

Set up

The project is set up using a multiple technologies. These are subject to change. In contributing we hope you are familiar or willing to be familiar with some the following:

  • Docker
  • Ruby
  • Rails
  • JavaScript
  • GeoCoordinates
  • MySQL

Depending on how you are looking to contribute and what milestones the project is at, the project may have some work needed in these technologies or new ones.

This the current stack for development and may change. The project is not at a place to leave any of these technologies just yet.

Before you code

Review the CONTRIBUTING doc

It is important to know a few things about this project.

  1. This project is team first. Here are the issues being worked on. Contributors should be ready to work with a team. If you are looking to explore on your own please fork, but understand the team can't really help you with your fork.

  2. Understand the milestones. While things like rebuilds and refactors are great, if they are not in the current milestone it might not be time for those or other features yet.

  3. Open a new issue. Should there be a great feature this project needs please open a detailed issue. This can be then added to a milestone.

  4. Pull Requests should start as an issue. To save you and every one time please be sure to start an issue and get it attached to a milestone before any Pull Requests are made.

Story Points

What are story points??

Story points are a unit of measure for expressing an estimate of the overall effort that will be required to fully implement a product backlog item or any other piece of work.

  • One ticket at a time maximum per person (not all tickets will have story points)
  • Tickets taken for points should be completed in 7 days.
  • 1 story point = $100
  • If you earn $600 or more, a 1099 will be issued.

Various Reference Links

Clone this wiki locally