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

Conversation

Bennett-Lynch
Copy link
Contributor

Motivation

Similar to how #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

License

  • I confirm that this pull request can be released under the Apache 2 license

Bennett Lynch added 2 commits August 10, 2021 15:42
## 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
## 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
@Bennett-Lynch Bennett-Lynch merged commit 3dd317c into aws:master Aug 10, 2021
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants