Skip to content

Create a shared, project-level IntelliJ inspection profile #2655

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Aug 10, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"category": "AWS SDK for Java v2",
"contributor": "",
"type": "documentation",
"description": "Create a shared, project-level IntelliJ inspection profile"
}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
# IntelliJ un-ignore
!.idea/codeStyles/
!.idea/copyright/
!.idea/inspectionProfiles/

# Mac
.DS_Store
Expand Down
5 changes: 5 additions & 0 deletions .idea/inspectionProfiles/AWS_Java_SDK_2_0.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 6 additions & 0 deletions .idea/inspectionProfiles/profiles_settings.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 7 additions & 3 deletions docs/GettingStarted.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,19 @@
generator][codegen]

### Development Environment Setup Tips
If you use IntelliJ IDEA, we recommend using the following config files, which will be used by default for your project-level settings:
If you use IntelliJ IDEA, the following config files will be used by default for your project-level settings:

- [Copyright](https://raw.githubusercontent.com/aws/aws-sdk-java-v2/master/.idea/copyright/AWS_Java_SDK_2_0.xml)

This automatically inserts the license header to the top of source files that you create.

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

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

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

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

If you have Checkstyle integrated with your IDE, we also recommend
configuring it with our
Expand Down