@sports-alliance/sports-lib
Version:
A Library to for importing / exporting and processing GPX, TCX, FIT and JSON files from services such as Strava, Movescount, Garmin, Polar etc
24 lines (16 loc) • 1.19 kB
Markdown
# Agent Configuration for sports-lib
This directory contains configuration, skills, and workflows for AI agents working on the `sports-lib` project.
## Structure
- **skills/**: Contains specialized "skills" (instructions + scripts) for the agent.
- `debug-utils`: Instructions for using the project's ad-hoc FIT file debugging scripts.
- **workflows/**: Contains step-by-step guides for common tasks.
- `add-new-data.md`: How to identify and add new data fields from FIT files.
## Usage
When asking an agent to help with debugging or adding data, you can refer them to these specific skills or workflows if they don't automatically pick them up.
- "Use the debug-utils skill to inspect this file."
- "Follow the add-new-data workflow."
## Agent Rule: New Data Types Must Update README
When an agent adds, renames, or removes any exported `Data*.type` in `src/data/`:
- Update the data catalog section in `README.md` (between `<!-- DATA_COVERAGE_START -->` and `<!-- DATA_COVERAGE_END -->`).
- Keep canonical metric tokens exactly as declared in code (including legacy whitespace tokens like `` ` Steps` ``).
- Include the README update in the same change/PR as the data-type change.