Skip to content

Commit 2fecc7e

Browse files
committed
Address user comments on AGENTS.md: slim down Getting Started and remove module link
1 parent ff84d84 commit 2fecc7e

1 file changed

Lines changed: 10 additions & 5 deletions

File tree

AGENTS.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,30 @@ Directories starting with `java-` are client libraries for specific Google Cloud
3232
- **Logging**: [java-logging](java-logging)
3333
- **Logging Logback**: [java-logging-logback](java-logging-logback)
3434

35-
## 3. Style Guide
35+
## 3. Getting Started
36+
This is a standard Maven project.
37+
- **Build all**: `mvn install -T 1C -P quick-build` from root (recommended).
38+
- **Scoped build**: Run `mvn` commands within specific module directories.
39+
- **Prerequisites**: Java 11+, Maven 3.0+, Bazelisk (for core integration tests).
40+
41+
## 4. Style Guide
3642
1. Minimize visibility scopes. Default to most restrictive access level.
3743
2. Use short names over fully qualified names.
3844
3. Avoid calling `@ObsoleteApi` or `@Deprecated` methods and classes.
3945
4. Avoid unnecessary formatting changes to keep diffs clean.
4046
5. Use `mvn` for everything other than the `test/integration` folder.
4147

42-
## 4. Dependency Management
48+
## 5. Dependency Management
4349
- Do not bump external dependency versions unless for CVE or critical bug fix.
4450
- Avoid introducing new external dependencies if possible. Prefer Java standard library, then opt for existing dependencies.
4551

46-
## 5. Contribution Guidelines
52+
## 6. Contribution Guidelines
4753
- **Commits**: Conventional Commits `<type>(<scope>): <description>`.
4854
- **Pull Requests**: Submitted via PR, require review. Pull latest from main and resolve conflicts.
4955
- **Testing**: All new logic should be accompanied by tests.
5056

51-
## 6. Specialized Development Guides
57+
## 7. Specialized Development Guides
5258
For development on core components, refer to the following guides in `sdk-platform-java`:
5359
- **GAPIC Generator**: [sdk-platform-java/gapic-generator-java/DEVELOPMENT.md](sdk-platform-java/gapic-generator-java/DEVELOPMENT.md)
5460
- **GAX**: [sdk-platform-java/gax-java/DEVELOPMENT.md](sdk-platform-java/gax-java/DEVELOPMENT.md)
5561
- **Hermetic Build**: [sdk-platform-java/hermetic_build/DEVELOPMENT.md](sdk-platform-java/hermetic_build/DEVELOPMENT.md)
56-
- **Core Specific Instructions**: [sdk-platform-java/AGENTS.md](sdk-platform-java/AGENTS.md)

0 commit comments

Comments
 (0)