Skip to content

Readme.developer.md

Latest commit

 

History

History
41 lines (31 loc) · 790 Bytes

Readme.developer.md

File metadata and controls

41 lines (31 loc) · 790 Bytes
Raw

GKit - Developer Guide

Project Structure

gkit/
├── igv-report/          # IGV Report utility
│   ├── Makefile         # Test target
│   ├── pixi.toml        # Dependencies
│   └── scripts/         # Utility scripts
├── Readme.md            # Project overview
└── Readme.developer.md  # This file

Running Tests

cd <utility-name>
make test

Adding a New Utility

  1. Create a new folder: <utility-name>/
  2. Add Makefile with test target
  3. Add pixi.toml with dependencies
  4. Add scripts in scripts/ folder

Example:

my-utility/
├── Makefile
├── pixi.toml
└── scripts/
    └── my_script.sh

CI/CD

GitHub Actions automatically runs make test on modified utilities.