Skip to content

AGENTS.md

Latest commit

 

History

History
115 lines (75 loc) · 3.19 KB

AGENTS.md

File metadata and controls

115 lines (75 loc) · 3.19 KB

Deedle – Agent Guide

Repository Overview

Deedle is an F# library for data manipulation providing efficient frame and series data structures (similar to Python's pandas). It supports missing values, aggregations, grouping, joining, statistics, and time-series alignment.

Key sub-projects:

Project Path
Core library src/Deedle/
.NET Interactive formatting src/Deedle.DotNetInteractive/
MathNet.Numerics integration src/Deedle.MathNetNumerics/
Excel integration src/Deedle.Excel/

Tests live under tests/.

Prerequisites

.NET SDK

See global.json

Setup (one-time after cloning)

# 1. Restore .NET local tools (includes Paket)
dotnet tool restore

# 2. Restore NuGet packages via Paket
dotnet paket restore

Both steps are required before any build or test command.

Building and Testing

Linux / macOS

# Full build + tests
./build.sh

# Build only (skip tests)
./build.sh --no-tests

Windows

# Full build + tests
.\build.ps1

# Build only (skip tests)
.\build.ps1 -NoTests

Individual projects

dotnet build src/Deedle/Deedle.fsproj -c Release
dotnet test tests/Deedle.Tests/Deedle.Tests.fsproj -c Release

Versioning

The library version is set in Directory.Build.props at the repo root. Update <Version> there when releasing, and add a corresponding entry at the top of RELEASE_NOTES.md.

When making any change that adds, alters, or fixes user-facing behaviour, you must:

  1. Update RELEASE_NOTES.md — add a bullet under the current unreleased version heading (or create a new version heading if one does not exist). Group entries by category: new packages, new operations, I/O, performance, bug fixes, infrastructure.
  2. Run and record benchmarks — if the change affects performance-sensitive code paths (Stats, Frame aggregation, CSV I/O, series windowing, etc.), run the BenchmarkDotNet suite under benchmarks/ before and after the change and include the relevant results in the PR description.

CI Workflow

CI is defined in .github/workflows/pull-requests.yml (PRs) and .github/workflows/push-master.yml (pushes to master). Both run on ubuntu-latest and windows-latest.

The exact CI steps are:

- dotnet tool restore
- dotnet paket restore
- ./build.sh          # or .\build.ps1 on Windows

A PR is considered passing when both the Windows and Ubuntu jobs succeed.

Common Failure Modes

Symptom Likely cause
Build fails with "paket not found" dotnet tool restore was not run
Paket errors about missing packages dotnet paket restore was not run
Deedle.RProvider.Plugin compile errors R is not installed or R_HOME is unset
Test failures in Deedle.Tests Logic regression in src/Deedle/
Test failures in Deedle.MathNetNumerics.Tests Logic regression in src/Deedle.MathNetNumerics/

Code Style and Conventions

  • All source is F# (.fs) except Deedle.CSharp.Tests which is C#.
  • Library projects target netstandard2.0 / netstandard2.1; test and plugin projects target net8.0.
  • Version is set in Directory.Build.props and RELEASE_NOTES.md.