Skip to content

Commit ef0dd8b

Browse files
authored
Merge pull request #2981 from adobe/copilot/update-documentation-best-practices
docs: fix incomplete configuration reference and missing doc files in agent skill
2 parents 49080a7 + 6a314b3 commit ef0dd8b

File tree

2 files changed

+15
-6
lines changed

2 files changed

+15
-6
lines changed

.claude/skills/document/SKILL.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Read `AGENTS.md` (root + relevant module) before making changes.
1515
| `CHANGELOG.md` | End users | Version history, breaking changes |
1616
| `docs/TESTING.md` | Contributors / AI agents | Testing strategy, base classes, patterns, commands |
1717
| `docs/KOTLIN.md` | Contributors / AI agents | Kotlin idioms, naming conventions, anti-patterns, KDoc |
18+
| `docs/SPRING.md` | Contributors / AI agents | Spring Boot patterns, DI, controllers, exception handling |
19+
| `docs/JAVA.md` | Contributors / AI agents | Java idioms, naming conventions, anti-patterns, Javadoc |
1820
| `AGENTS.md` (root + modules) | AI agents | Architecture, conventions, guardrails |
1921
| `.github/CONTRIBUTING.md` | Contributors | Dev setup, code reviews |
2022

@@ -26,6 +28,10 @@ Read `AGENTS.md` (root + relevant module) before making changes.
2628

2729
**Architecture change**: relevant module's `AGENTS.md`, root `AGENTS.md` if cross-cutting, `CHANGELOG.md`.
2830

31+
**Spring Boot pattern change**: `docs/SPRING.md`, `server/AGENTS.md` if the change affects how controllers/services/stores are structured.
32+
33+
**Kotlin/Java style change**: `docs/KOTLIN.md` or `docs/JAVA.md`, root `AGENTS.md` DO/DON'T section if it introduces a new guardrail.
34+
2935
## CHANGELOG Format
3036

3137
Follow existing pattern: group under current version heading, clear user-facing language, note breaking changes, reference issues/PRs.

AGENTS.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -78,12 +78,14 @@ Filesystem layout:
7878

7979
## Configuration
8080

81-
Environment variables (prefix: `COM_ADOBE_TESTING_S3MOCK_STORE_`):
82-
- `ROOT` - storage directory
83-
- `RETAIN_FILES_ON_EXIT` - keep files after shutdown
84-
- `REGION` - AWS region (default: us-east-1)
85-
- `INITIAL_BUCKETS` - comma-separated bucket names
86-
- `VALID_KMS_KEYS` - valid KMS ARNs
81+
Environment variables:
82+
- `COM_ADOBE_TESTING_S3MOCK_STORE_ROOT` - storage directory
83+
- `COM_ADOBE_TESTING_S3MOCK_STORE_RETAIN_FILES_ON_EXIT` - keep files after shutdown (default: false)
84+
- `COM_ADOBE_TESTING_S3MOCK_STORE_REGION` - AWS region (default: us-east-1)
85+
- `COM_ADOBE_TESTING_S3MOCK_STORE_INITIAL_BUCKETS` - comma-separated bucket names
86+
- `COM_ADOBE_TESTING_S3MOCK_STORE_VALID_KMS_KEYS` - valid KMS ARNs
87+
- `COM_ADOBE_TESTING_S3MOCK_CONTROLLER_CONTEXT_PATH` - base context path for all endpoints (default: "")
88+
- `debug` / `trace` - Spring Boot log levels
8789

8890
## Error Handling
8991

@@ -100,6 +102,7 @@ See **[docs/TESTING.md](docs/TESTING.md)** for the full testing strategy, base c
100102
```bash
101103
make install # Full build
102104
make skip-docker # Skip Docker
105+
make test # Unit tests only
103106
make integration-tests # Run integration tests
104107
make format # Format Kotlin code
105108
```

0 commit comments

Comments
 (0)