Skip to content

Commit 3e5522b

Browse files
authored
DVPL-13432 add AGENTS.md routing targets (#841)
1 parent 7c89e92 commit 3e5522b

2 files changed

Lines changed: 6 additions & 8 deletions

File tree

‎AGENTS.md‎

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55
- Core SDK code lives in `splunklib/` (client bindings, search commands, modular input helpers). Keep new modules close to their domain peers (e.g., searchcommand utilities under `splunklib/searchcommands`).
66
- `splunklib/ai/` is the primary active development area - a provider-agnostic LLM agent framework for embedding AI into Splunk Apps.
77
- Tests are split by scope: `tests/unit/`, `tests/integration/`, `tests/system/`, and `tests/searchcommands/` for app-style fixtures. Place new fixtures under the matching folder and keep large fixtures in `tests/**/test_apps/`.
8+
- See `splunklib/ai/README.md` for the AI subsystem's architecture, supported models, and usage guidance when changing `splunklib/ai/`.
9+
- See `docs/` for the Sphinx API reference when changing or documenting public SDK modules.
810

911
## Package Manager
1012

@@ -16,16 +18,16 @@ make install
1618

1719
If you manually edit `pyproject.toml` to add/remove/update dependencies, run `make install` afterwards to update `uv.lock`.
1820

19-
The `Makefile` wraps `uv` commands - prefer `make` targets over invoking `uv` directly where a target exists.
21+
The `Makefile` wraps `uv` commands - see `./Makefile` for available targets, and prefer `make` targets over invoking `uv` directly where a target exists.
2022

2123
## Build, Test, and Development Commands
2224

23-
See the `Makefile` for all available targets. Common ones:
25+
See `./Makefile` for all available targets. Common ones:
2426

2527
- `make install` - set up / update virtualenv
2628
- `make test` - run the full pytest suite.
27-
- `make test-unit` - unit tests only; fastest feedback loop.
28-
- `make test-integration` - integration + system coverage; requires Splunk services available (see docker targets).
29+
- `make test-unit` - unit tests only; fastest feedback loop. See `tests/unit/` for unit-test cases when adding or updating unit tests.
30+
- `make test-integration` - integration + system coverage; requires Splunk services available (see `tests/integration/` for integration test cases and `./Makefile` for Docker targets).
2931
- `make test-ai` - AI subsystem tests only.
3032
- `make docker-start` / `make docker-down` - spin up or stop the Splunk test container. Make sure the instance is live before running integration tests.
3133

‎CLAUDE.md‎

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)