From 85aee70bbf158833bc40ac129e376d7bbca940f2 Mon Sep 17 00:00:00 2001 From: "copilot-swe-agent[bot]" <198982749+Copilot@users.noreply.github.com> Date: Tue, 5 May 2026 22:41:39 +0000 Subject: [PATCH] chore: add AGENTS.md, copilot-instructions.md; remove gitpod support Agent-Logs-Url: https://github.com/jet/propulsion/sessions/f0c5210a-af06-4620-924b-6777f1055827 Co-authored-by: bartelink <206668+bartelink@users.noreply.github.com> --- .github/copilot-instructions.md | 17 +++++++++++++++++ .gitpod.yml | 30 ----------------------------- AGENTS.md | 34 +++++++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+), 30 deletions(-) create mode 100644 .github/copilot-instructions.md delete mode 100644 .gitpod.yml create mode 100644 AGENTS.md diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md new file mode 100644 index 00000000..bb9061b3 --- /dev/null +++ b/.github/copilot-instructions.md @@ -0,0 +1,17 @@ +# Copilot Instructions + +Propulsion is a suite of .NET/F# NuGet packages for reactive event-processing pipelines. + +## Build & test + +```bash +dotnet build Propulsion.sln --configuration Release +dotnet test Propulsion.sln --no-restore --verbosity minimal +``` + +## Key conventions + +- All library code is **F#**; follow existing style in each file. +- Keep public API changes minimal and backward-compatible where possible. +- Do not introduce new NuGet dependencies without a strong reason. +- Each package lives in its own subdirectory under `src/`. diff --git a/.gitpod.yml b/.gitpod.yml deleted file mode 100644 index 96645f45..00000000 --- a/.gitpod.yml +++ /dev/null @@ -1,30 +0,0 @@ -image: - file: .gitpod/gitpod.Dockerfile - -tasks: - - name: Build - before: "./.gitpod/gitpod-init.sh" - init: | - dotnet build ./Propulsion.sln - -vscode: - extensions: - - Ionide.Ionide-fsharp@5.9.0 - - muhammad-sammy.csharp@1.23.16 - -github: - prebuilds: - # enable for the master/default branch (defaults to true) - master: true - # enable for all branches in this repo (defaults to false) - branches: true - # enable for pull requests coming from this repo (defaults to true) - pullRequests: true - # enable for pull requests coming from forks (defaults to false) - pullRequestsFromForks: true - # add a check to pull requests (defaults to true) - addCheck: false - # add a "Review in Gitpod" button as a comment to pull requests (defaults to false) - addComment: false - # add a "Review in Gitpod" button to the pull request's description (defaults to false) - addBadge: false diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 00000000..acb8d67b --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,34 @@ +# Agent Guidelines for Propulsion + +This repository contains the **Propulsion** library — a suite of .NET NuGet packages for building reactive event-processing pipelines on top of event stores such as EventStoreDB, MessageDB, and the [Equinox](https://github.com/jet/equinox) stores (CosmosStore, DynamoStore, MemoryStore). + +See [`.github/copilot-instructions.md`](.github/copilot-instructions.md) for Copilot-specific instructions. + +## Repository layout + +| Path | Purpose | +|---|---| +| `src/` | Library source — one directory per NuGet package | +| `tests/` | Test projects | +| `tools/` | Helper tooling | +| `DOCUMENTATION.md` | In-depth documentation | +| `CHANGELOG.md` | Release history | + +## Build & test + +```bash +# Build +dotnet build Propulsion.sln --configuration Release + +# Test (requires a local Postgres instance for MessageDb tests) +dotnet test Propulsion.sln --no-restore --verbosity minimal +``` + +The CI workflow (`.github/workflows/ci.yaml`) spins up Postgres and installs `message-db` automatically; for local runs without Postgres the MessageDb-related tests will be skipped or fail. + +## Language & style + +- All library code is written in **F#**. +- Follow the conventions already present in each file — no tabs, 4-space indent. +- Do not add external dependencies unless absolutely necessary. +- Keep public API surface minimal and consistent with existing packages.