Skip to content
David Fawcett edited this page Jul 21, 2015 · 12 revisions

Contributing to the Project

This entire project is hosted on Github, the map, the data, all of it. This allows you to add to or modify all parts of the project using this workflow.

At a high level, you will:

  • fork this project on Github
  • clone your fork of the project to a local computer
  • make your edits
  • add and commit the changes to your local repo
  • push to your GitHub fork of the project
  • create a pull request on GitHub

The project admins will then:

  • review the pull request
  • merge the commit into the project master branch and resolve any conflicts
  • merge master into the gh-pages branch

Adding a new point to the map!

Probably the most simple way to start contributing to the project is to add one of your favorite places to the map. To do this, you will add some data to a file called places.json. We will learn how to do this using commandline tools (bash on OSX or Git Bash on Windows). There are GUI Git tools that can help you with this too.

###1. Create a Local Repo and Configure Git ###2. Add a New Place of Interest ###3. Commit Your Changes and Contribute Them Back