Skip to content

Navigation Menu

Sign in
Appearance settings
Sign up
Appearance settings

Commit 5e81393

Browse filesBrowse the repository at this point in the historyBrowse files
Copilotbartelink
andauthored
chore: add AGENTS.md, copilot-instructions.md; remove gitpod support (#274)
Agent-Logs-Url: https://github.com/jet/propulsion/sessions/f0c5210a-af06-4620-924b-6777f1055827 Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: bartelink <206668+bartelink@users.noreply.github.com>
1 parent 4987907 commit 5e81393
Copy full SHA for 5e81393

3 files changed

+51-30Lines changed: 51 additions & 30 deletions

File tree

Expand file treeCollapse file tree
Open diff view settings
Filter options
Expand file treeCollapse file tree
Open diff view settings
Collapse file

‎.github/copilot-instructions.md‎

Copy file name to clipboard
+17Lines changed: 17 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Copilot Instructions
2+
3+
Propulsion is a suite of .NET/F# NuGet packages for reactive event-processing pipelines.
4+
5+
## Build & test
6+
7+
```bash
8+
dotnet build Propulsion.sln --configuration Release
9+
dotnet test Propulsion.sln --no-restore --verbosity minimal
10+
```
11+
12+
## Key conventions
13+
14+
- All library code is **F#**; follow existing style in each file.
15+
- Keep public API changes minimal and backward-compatible where possible.
16+
- Do not introduce new NuGet dependencies without a strong reason.
17+
- Each package lives in its own subdirectory under `src/`.
Collapse file

‎.gitpod.yml‎

Copy file name to clipboardExpand all lines: .gitpod.yml
-30Lines changed: 0 additions & 30 deletions
This file was deleted.
Collapse file

‎AGENTS.md‎

Copy file name to clipboard
+34Lines changed: 34 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Agent Guidelines for Propulsion
2+
3+
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).
4+
5+
See [`.github/copilot-instructions.md`](.github/copilot-instructions.md) for Copilot-specific instructions.
6+
7+
## Repository layout
8+
9+
| Path | Purpose |
10+
|---|---|
11+
| `src/` | Library source — one directory per NuGet package |
12+
| `tests/` | Test projects |
13+
| `tools/` | Helper tooling |
14+
| `DOCUMENTATION.md` | In-depth documentation |
15+
| `CHANGELOG.md` | Release history |
16+
17+
## Build & test
18+
19+
```bash
20+
# Build
21+
dotnet build Propulsion.sln --configuration Release
22+
23+
# Test (requires a local Postgres instance for MessageDb tests)
24+
dotnet test Propulsion.sln --no-restore --verbosity minimal
25+
```
26+
27+
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.
28+
29+
## Language & style
30+
31+
- All library code is written in **F#**.
32+
- Follow the conventions already present in each file — no tabs, 4-space indent.
33+
- Do not add external dependencies unless absolutely necessary.
34+
- Keep public API surface minimal and consistent with existing packages.

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.