@@ -32,45 +32,25 @@ 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. Getting Started
36- ### Prerequisites
37- - Java 11+ (build targets Java 8 bytecode compatibility)
38- - Maven 3.0+
39- - Bazelisk (for integration tests in ` sdk-platform-java ` )
40-
41- ### Building the Project
42- - Build all modules: ` mvn install ` from root.
43- - Recommended for faster builds: ` mvn install -T 1C -P quick-build ` .
44- - Build specific module: Run ` mvn ` commands within the module directory.
45-
46- ### Code Formatting
47- - Check: ` mvn fmt:check `
48- - Format: ` mvn fmt:format `
49- - Tip: Run in specific module to save time.
50-
51- ## 4. Testing Strategy
52- - ** Unit Tests** : ` mvn test ` .
53- - ** Integration Tests** : Module specific, may require emulators or live services.
54- - ** Core Components Testing** : Components should have adequate unit and integration tests to ensure coverage and correctness.
55-
56- ## 5. Style Guide
35+ ## 3. Style Guide
57361 . Minimize visibility scopes. Default to most restrictive access level.
58372 . Use short names over fully qualified names.
59383 . Avoid calling ` @ObsoleteApi ` or ` @Deprecated ` methods and classes.
60394 . Avoid unnecessary formatting changes to keep diffs clean.
61405 . Use ` mvn ` for everything other than the ` test/integration ` folder.
6241
63- ## 6 . Dependency Management
42+ ## 4 . Dependency Management
6443- Do not bump external dependency versions unless for CVE or critical bug fix.
6544- Avoid introducing new external dependencies if possible. Prefer Java standard library, then opt for existing dependencies.
6645
67- ## 7 . Contribution Guidelines
46+ ## 5 . Contribution Guidelines
6847- ** Commits** : Conventional Commits ` <type>(<scope>): <description> ` .
6948- ** Pull Requests** : Submitted via PR, require review. Pull latest from main and resolve conflicts.
7049- ** Testing** : All new logic should be accompanied by tests.
7150
72- ## 8 . Specialized Development Guides
51+ ## 6 . Specialized Development Guides
7352For development on core components, refer to the following guides in ` sdk-platform-java ` :
7453- ** GAPIC Generator** : [ sdk-platform-java/gapic-generator-java/DEVELOPMENT.md] ( sdk-platform-java/gapic-generator-java/DEVELOPMENT.md )
7554- ** GAX** : [ sdk-platform-java/gax-java/DEVELOPMENT.md] ( sdk-platform-java/gax-java/DEVELOPMENT.md )
7655- ** 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