Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (29 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

39 lines (29 loc) · 1.22 KB

Contributing to ExtFit

Setup

Local repository

# use your own fork 
$ git clone git@github.com:arathunku/ext_fit.git
$ cd ext_fit
$ mix deps.get
# ensure everything works
$ mix test 
# do your changes
$ mix check

Updating to new SDK

Requires Nix package manager.

  1. Get new SDK from developer.garmin.com
  2. Save .zip in "sdks/" directory and unzip it next to it with fit-sdk-{{version}}
  3. Run scripts/profile-xlsx-as-csv. This uses LibreOffice to convert xlsx to csv
  4. Update version in scripts/gen-profile
  5. Generate new profile files with scripts/gen-profile

Add new test FIT files

Requires Nix package manager.

  1. Add new file to test/support/files

  2. Please use name {{YYYY}}-{{MM}}-{{DD}}-{{company}}-{{device}}-{{context}}.fit where date should mostly match date when the activity was recorded

  3. Optional:

  4. Run scripts/generate-dumps-for-test-files, this will use official fit2csv tool to dump .csv file,