Skip to content

Contribution guide

Stefan Midjich edited this page Nov 29, 2016 · 6 revisions

A guide for contributions to Siptrack.

First steps

  1. Read Wiki front page about what Siptrack is
  2. Read how to setup personal dev environment
  3. Setup your own personal dev environment
  4. Test your local Siptrack install
  5. Decide which part of Siptrack to work on (client lib, api service or web interface)

Typical workflow

  1. Fork repo on Github
  2. Create a new branch for your changes in your fork
  3. Clone your local fork to your system
  4. Make your changes in your local branch
  5. Test your changes locally as well as possible
  6. Create a PR for your fork and submit it to the parent repo
  7. Explain in the PR what your goal with the change was and how you've tested it