Skip to content

Commit f3069b8

Browse files
author
Bennett Lynch
committed
Create a shared, project-level IntelliJ inspection profile
## Motivation Similar to how aws#2652 recently moved our code style & copyright configuration files to the project-level, we can also do the same for IntelliJ inspections. This has the benefit of keeping inspections in sync for all users, as well as automatically informing new users of our expected coding best practices. We do not currently have an existing inspection profile, so we will take this opportunity to start with a new, blank inspection profile. Users may then propose customizing the inspections via PRs, subject to the normal review process. Over time we will gravitate towards a shared inspection profile that we can all agree on. ## Modifications * Create a new, blank "AWS Java SDK 2.0" inspection profile * Update profiles_settings.xml to make users use this profile * Add corresponding gitignore update * Add corresponding GettingStarted update
1 parent c059320 commit f3069b8

File tree

5 files changed

+23
-3
lines changed

5 files changed

+23
-3
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"category": "AWS SDK for Java v2",
3+
"contributor": "",
4+
"type": "documentation",
5+
"description": "Create a shared, project-level IntelliJ inspection profile"
6+
}

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
# IntelliJ un-ignore
1212
!.idea/codeStyles/
1313
!.idea/copyright/
14+
!.idea/inspectionProfiles/
1415

1516
# Mac
1617
.DS_Store

.idea/inspectionProfiles/AWS_Java_SDK_2_0.xml

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.idea/inspectionProfiles/profiles_settings.xml

Lines changed: 6 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/GettingStarted.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,19 @@
77
generator][codegen]
88

99
### Development Environment Setup Tips
10-
If you use IntelliJ IDEA, we recommend using the following config files, which will be used by default for your project-level settings:
10+
If you use IntelliJ IDEA, the following config files will be used by default for your project-level settings:
11+
12+
- [Copyright](https://raw.githubusercontent.com/aws/aws-sdk-java-v2/master/.idea/copyright/AWS_Java_SDK_2_0.xml)
13+
14+
This automatically inserts the license header to the top of source files that you create.
1115

1216
- [Code style](https://raw.githubusercontent.com/aws/aws-sdk-java-v2/master/.idea/codeStyles/Project.xml)
1317

1418
This will help ensure your code follows our code style guidelines.
1519

16-
- [Copyright](https://raw.githubusercontent.com/aws/aws-sdk-java-v2/master/.idea/copyright/AWS_Java_SDK_2_0.xml)
20+
- [Inspections](https://raw.githubusercontent.com/aws/aws-sdk-java-v2/master/.idea/inspectionProfiles/AWS_Java_SDK_2_0.xml)
1721

18-
This automatically inserts the license header to the top of source files that you create.
22+
This will help ensure your code is correct and follows our best practices. Please ensure your changes do not generate any new inspection warnings.
1923

2024
If you have Checkstyle integrated with your IDE, we also recommend
2125
configuring it with our

0 commit comments

Comments
 (0)