Skip to content

Commit 1dc18e9

Browse files
committed
docs: add/update AGENTS.md with clear Why/What
1 parent 6ffe92e commit 1dc18e9

1 file changed

Lines changed: 7 additions & 22 deletions

File tree

AGENTS.md

Lines changed: 7 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,13 @@
22

33
## What
44

5-
Enhance data quality with Soda integration in Kestra workflows. Exposes 1 plugin components (tasks, triggers, and/or conditions).
5+
- Provides plugin components under `io.kestra.plugin.soda`.
6+
- Includes classes such as `Scan`, `ScanResult`, `DiscoverTablesResultTable`, `Metric`.
67

78
## Why
89

9-
Enables Kestra workflows to interact with Soda, allowing orchestration of Soda-based operations as part of data pipelines and automation workflows.
10+
- This plugin integrates Kestra with Soda.
11+
- It provides tasks that run Soda scans for data quality checks.
1012

1113
## How
1214

@@ -30,24 +32,7 @@ plugin-soda/
3032
└── README.md
3133
```
3234

33-
### Important Commands
35+
## References
3436

35-
```bash
36-
# Build the plugin
37-
./gradlew shadowJar
38-
39-
# Run tests
40-
./gradlew test
41-
42-
# Build without tests
43-
./gradlew shadowJar -x test
44-
```
45-
46-
### Configuration
47-
48-
All tasks and triggers accept standard Kestra plugin properties. Credentials should use
49-
`{{ secret('SECRET_NAME') }}` — never hardcode real values.
50-
51-
## Agents
52-
53-
**IMPORTANT:** This is a Kestra plugin repository (prefixed by `plugin-`, `storage-`, or `secret-`). You **MUST** delegate all coding tasks to the `kestra-plugin-developer` agent. Do NOT implement code changes directly — always use this agent.
37+
- https://kestra.io/docs/plugin-developer-guide
38+
- https://kestra.io/docs/plugin-developer-guide/contribution-guidelines

0 commit comments

Comments
 (0)