Skip to content

Commit ab9fcd5

Browse files
committed
docs: Add per-agent instruction files pointing to AGENTS.md
Add root entrypoints so the major AI coding agents pick up the repo's existing AGENTS.md guidance: - CLAUDE.md — Claude Code (imports AGENTS.md via @import) - GEMINI.md — Gemini CLI (imports AGENTS.md via @import) - .github/copilot-instructions.md — GitHub Copilot (prose pointer; Copilot instructions do not support file imports) AGENTS.md remains the single source of truth. Codex, Cursor, Windsurf, Aider, Zed, etc. already read AGENTS.md natively and need no extra file. --- X-AI-Prompt: Replicate AGENTS.md for Claude, Gemini, and Copilot; raise/update PR X-AI-Tool: Kiro
1 parent 2fc624f commit ab9fcd5

3 files changed

Lines changed: 55 additions & 0 deletions

File tree

‎.github/copilot-instructions.md‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# GitHub Copilot instructions — Amazon SageMaker Python SDK
2+
3+
Guidance for [GitHub Copilot](https://docs.github.com/en/copilot) working in
4+
**this repository** — the source of the Amazon SageMaker Python SDK.
5+
6+
This repository keeps its AI-agent guidance in a single source of truth,
7+
[`AGENTS.md`](../AGENTS.md), following the [AGENTS.md](https://agents.md) convention.
8+
Copilot instructions do not support file imports, so **read
9+
[`AGENTS.md`](../AGENTS.md) at the repository root and follow it**.
10+
11+
Key points from that file (see `AGENTS.md` for the authoritative, complete version):
12+
13+
- **v3 by default.** The current major version is v3 (`pip install sagemaker`). SDK v3 is a
14+
modular redesign and is **not** backward compatible with v2. Generate v3 patterns in all
15+
example code, docstrings, tests, and docs unless v2 is explicitly in scope.
16+
- **SDK-first.** Use the SageMaker Python SDK v3 as the primary interface (e.g.
17+
`sagemaker.train.ModelTrainer`, `sagemaker.serve.ModelBuilder`); do not drop to raw
18+
`boto3`, the AWS CLI, or hand-rolled scripts unless the SDK genuinely does not cover the
19+
task.
20+
- **No banned v2 patterns** (e.g. `sagemaker.estimator.Estimator`, `estimator.fit(...)`,
21+
framework estimator classes, `sagemaker.model.Model`) in new code. See the v2 → v3
22+
mapping table in `AGENTS.md` and [`migration.md`](../migration.md).
23+
- **Contributing:** add/update unit tests under `tests/unit/` for code changes, run the
24+
configured formatters/linters, and keep `migration.md` and docstrings consistent for
25+
public API changes. See [`CONTRIBUTING.md`](../CONTRIBUTING.md).

‎CLAUDE.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# CLAUDE.md — Amazon SageMaker Python SDK
2+
3+
Guidance for [Claude Code](https://docs.anthropic.com/en/docs/claude-code) working in
4+
**this repository** — the source of the Amazon SageMaker Python SDK.
5+
6+
This repository follows the [AGENTS.md](https://agents.md) convention. To keep a single
7+
source of truth and avoid the two files drifting apart, all guidance lives in
8+
[`AGENTS.md`](./AGENTS.md) and is imported here:
9+
10+
@AGENTS.md
11+
12+
For the full guidance — project context, the **v3-by-default** golden rule, banned v2
13+
patterns and their v3 replacements, the SDK-first interface map, the contributing
14+
workflow, and a canonical v3 train + deploy example — read [`AGENTS.md`](./AGENTS.md)
15+
directly.

‎GEMINI.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# GEMINI.md — Amazon SageMaker Python SDK
2+
3+
Guidance for [Gemini CLI](https://github.com/google-gemini/gemini-cli) working in
4+
**this repository** — the source of the Amazon SageMaker Python SDK.
5+
6+
This repository follows the [AGENTS.md](https://agents.md) convention. To keep a single
7+
source of truth and avoid the files drifting apart, all guidance lives in
8+
[`AGENTS.md`](./AGENTS.md) and is imported here:
9+
10+
@AGENTS.md
11+
12+
For the full guidance — project context, the **v3-by-default** golden rule, banned v2
13+
patterns and their v3 replacements, the SDK-first interface map, the contributing
14+
workflow, and a canonical v3 train + deploy example — read [`AGENTS.md`](./AGENTS.md)
15+
directly.

0 commit comments

Comments
 (0)