Skip to content

Commit 5a634d9

Browse files
committed
chore: fix skill relative paths and refine prerequisites in AGENTS.md
1 parent c6046d2 commit 5a634d9

2 files changed

Lines changed: 11 additions & 11 deletions

File tree

.agents/skills/java-development/SKILL.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,20 @@ Use this skill when tasked with modifying Java code, fixing bugs, or adding feat
1111

1212
### Step 1: Understand the Scope
1313
- Determine if you are working on **Core Components** (`sdk-platform-java`) or a specific **Client Library** (`java-<service>`).
14-
- Review the root [AGENTS.md](../../AGENTS.md) for the Style Guide and Dependency Management rules that apply repo-wide.
14+
- Review the root [AGENTS.md](../../../AGENTS.md) for the Style Guide and Dependency Management rules that apply repo-wide.
1515

1616
### Step 2: Make Changes and Build
1717
- Apply your code changes.
18-
- To build efficiently, use the recommended flags or scoped builds detailed in [AGENTS.md](../../AGENTS.md#building-the-project).
18+
- To build efficiently, use the recommended flags or scoped builds detailed in [AGENTS.md](../../../AGENTS.md#building-the-project).
1919

2020
### Step 3: Determine and Run Tests
2121
- If working on a **Client Library**, run its unit tests (`mvn test` in the module directory) and check its README for integration test procedures.
2222
- If working on **Core Components** (`sdk-platform-java`), you **must** follow the testing heuristics in [sdk-platform-java/DEVELOPMENT.md](../../../sdk-platform-java/DEVELOPMENT.md#testing-guide) to know which tests are required.
23-
- If golden files need updating, follow the specific procedures referenced in [AGENTS.md](../../AGENTS.md#specialized-development-guides).
23+
- If golden files need updating, follow the specific procedures referenced in [AGENTS.md](../../../AGENTS.md#8-specialized-development-guides).
2424

2525
### Step 4: Format Code
26-
- You **must** ensure the code is formatted before completing a task. Use the formatting commands listed in [AGENTS.md](../../AGENTS.md#code-formatting).
26+
- You **must** ensure the code is formatted before completing a task. Use the formatting commands listed in [AGENTS.md](../../../AGENTS.md#code-formatting).
2727

2828
### Step 5: Verify and Document
2929
- Verify that all tests pass and formatting is correct.
30-
- Follow the Contribution Guidelines in [AGENTS.md](../../AGENTS.md#7-contribution-guidelines) for creating commits and PRs.
30+
- Follow the Contribution Guidelines in [AGENTS.md](../../../AGENTS.md#7-contribution-guidelines) for creating commits and PRs.

AGENTS.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,12 @@ Directories starting with `java-` are client libraries for specific Google Cloud
3030
- **Storage NIO**: [java-storage-nio](java-storage-nio)
3131
- **Datastore**: [java-datastore](java-datastore)
3232
- **Logging**: [java-logging](java-logging)
33+
- **Logging Logback**: [java-logging-logback](java-logging-logback)
3334

3435
## 3. Getting Started
3536
### Prerequisites
36-
- Java 11+
37-
- Maven
37+
- Java 11+ (build targets Java 8 bytecode compatibility)
38+
- Maven 3.0+
3839
- Bazelisk (for integration tests in `sdk-platform-java`)
3940

4041
### Building the Project
@@ -50,19 +51,18 @@ Directories starting with `java-` are client libraries for specific Google Cloud
5051
## 4. Testing Strategy
5152
- **Unit Tests**: `mvn test`.
5253
- **Integration Tests**: Module specific, may require emulators or live services.
53-
- **Core Components Testing**: See [sdk-platform-java/DEVELOPMENT.md](sdk-platform-java/DEVELOPMENT.md) for a detailed explanation of the 4 layers of testing (Traditional Unit, Golden Unit, Showcase, Golden Integration).
54+
- **Core Components Testing**: Components should have adequate unit and integration tests to ensure coverage and correctness.
5455

5556
## 5. Style Guide
5657
1. Minimize visibility scopes. Default to most restrictive access level.
5758
2. Use short names over fully qualified names.
58-
3. Avoid calling `@ObsoleteApi` or `@Deprecated` methods.
59+
3. Avoid calling `@ObsoleteApi` or `@Deprecated` methods and classes.
5960
4. Avoid unnecessary formatting changes to keep diffs clean.
6061
5. Use `mvn` for everything other than the `test/integration` folder.
6162

6263
## 6. Dependency Management
6364
- Do not bump external dependency versions unless for CVE or critical bug fix.
64-
- Avoid introducing new external dependencies.
65-
- Prefer Java standard library, then existing dependencies.
65+
- Avoid introducing new external dependencies if possible. Prefer Java standard library, then opt for existing dependencies.
6666

6767
## 7. Contribution Guidelines
6868
- **Commits**: Conventional Commits `<type>(<scope>): <description>`.

0 commit comments

Comments
 (0)