Skip to content

Commit ba102d6

Browse files
authored
Refactor guidelines and add kiro steering docs (#6280)
1 parent 288ef47 commit ba102d6

23 files changed

+1211
-65
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ target/
3030

3131
# VS Code
3232
.vscode/*
33+
bin/
3334

3435
# Other
3536
.attach_pid*
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Asynchronous Programming Guidelines for AWS SDK v2
3+
inclusion: fileMatch
4+
fileMatchPattern: "**/*.java"
5+
---
6+
7+
# Asynchronous Programming Guidelines for AWS SDK v2
8+
9+
For complete guidelines, refer to: #[[file:docs/guidelines/async-programming-guidelines.md]]
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: AWS SDK for Java v2 General Guidelines
3+
inclusion: always
4+
---
5+
6+
# AWS SDK for Java v2 General Guidelines
7+
8+
## Development Environment
9+
10+
- **Java Version**: Java 8 is the target language version for the AWS SDK for Java v2
11+
- **Build System**: Maven is used for building and dependency management
12+
13+
## Build Instructions
14+
15+
To check if the SDK compiles properly, follow these steps:
16+
17+
1. **Build with dependencies**: Only need to run once. First run the build command with `--am` (also-make) flag to build all dependencies:
18+
```bash
19+
mvn clean install -pl :${module} -P quick --am
20+
```
21+
Example for S3 module:
22+
```bash
23+
mvn clean install -pl :s3 -P quick --am
24+
```
25+
26+
2. **Build module only**: Then run the build for just the specific module (skips testing and checkstyles):
27+
```bash
28+
mvn clean install -pl :${module} -P quick
29+
```
30+
31+
3. **Run tests**: To run tests, use the standard command without the quick profile:
32+
```bash
33+
mvn clean install -pl :${module}
34+
```
35+
36+
## Guidelines
37+
38+
All detailed guidelines are in #[[file:docs/guidelines/aws-sdk-java-v2-general.md]]
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: "Client Configuration Guidelines for AWS SDK v2"
3+
inclusion: fileMatch
4+
fileMatchPattern: "**/*{Config,Configuration,Builder}*.java"
5+
---
6+
7+
# Client Configuration Guidelines for AWS SDK v2
8+
9+
For complete guidelines, refer to: #[[file:docs/guidelines/ClientConfiguration.md]]
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Code Generation Guidelines for AWS SDK v2
3+
inclusion: fileMatch
4+
fileMatchPattern: "{codegen/**/*.java,**/poet/**/*.java}"
5+
---
6+
7+
# Code Generation Guidelines for AWS SDK v2
8+
9+
For complete guidelines, refer to: #[[file:docs/guidelines/code-generation-guidelines.md]]
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Javadoc Guidelines for AWS SDK v2
3+
inclusion: fileMatch
4+
fileMatchPattern: "{**/src/main/**/*.java}"
5+
---
6+
7+
# Javadoc Guidelines for AWS SDK v2
8+
9+
For complete guidelines, refer to: #[[file:docs/guidelines/javadoc-guidelines.md]]
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: "Logging Guidelines for AWS SDK v2"
3+
inclusion: fileMatch
4+
fileMatchPattern: "**/*.java"
5+
---
6+
7+
# Logging Guidelines for AWS SDK v2
8+
9+
For complete guidelines, refer to: #[[file:docs/guidelines/logging-guidelines.md]]
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: "Reactive Streams Implementation Guidelines"
3+
inclusion: fileMatch
4+
fileMatchPattern: '**/*{Publisher,Subscriber}*.java'
5+
---
6+
7+
# Reactive Streams Implementation Guidelines
8+
9+
See #[[file:docs/guidelines/reactive-streams-guidelines.md]] for detailed implementation guidelines, patterns, and testing requirements.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Testing Guidelines for AWS SDK v2
3+
inclusion: fileMatch
4+
fileMatchPattern: "**/{test,it}/**/*.java"
5+
---
6+
7+
# Testing Guidelines for AWS SDK v2
8+
9+
For complete guidelines, refer to: #[[file:docs/guidelines/testing-guidelines.md]]

docs/design/APIReference.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

0 commit comments

Comments
 (0)