IGNITE-21467: improvements for pmd and checkstyle rules#3239
Merged
PakhomovAlexander merged 5 commits intoapache:mainfrom Feb 27, 2024
Merged
IGNITE-21467: improvements for pmd and checkstyle rules#3239PakhomovAlexander merged 5 commits intoapache:mainfrom
PakhomovAlexander merged 5 commits intoapache:mainfrom
Conversation
| <property name="tokens" value="SINGLE_LINE_COMMENT, BLOCK_COMMENT_BEGIN"/> | ||
| </module> | ||
| <!-- Comments should start with space --> | ||
| <module name="TodoComment"> |
Contributor
There was a problem hiding this comment.
Just wonder why it is called TodoComment.
Contributor
Author
There was a problem hiding this comment.
Just wonder why it is called TodoComment.
The original CheckStyle rule itself is for checking if there are any TODO in your comments, and if there are, it issues a warning. We use custom regexp for that rule to check if comment starts with something but space, instead of checking if it contains TODO
Contributor
|
We try to follow this pattern in git comment message: IGNITE-21467 Improve pmd and checkstyle rules |
ivanzlenko
approved these changes
Feb 20, 2024
* Allows us to upgrade to PMD 7 in the future * A few cases which was marked by pmd EmptyControlStatement were suppressed due to: > we have some cases when an empty statement is allowed.
* fixes or suppresses violations found depending on situation
* According to Apache code style poliies comments should start with space. * Exception is made for visual separator comments: * starting with --- * starting with === * CHECKSTYLE:ON
# Conflicts: # modules/catalog/src/main/java/org/apache/ignite/internal/catalog/commands/AlterTableDropColumnCommand.java # modules/core/src/main/java/org/apache/ignite/internal/util/GridUnsafe.java # modules/runner/src/integrationTest/java/org/apache/ignite/internal/table/ItTableScanTest.java # modules/sql-engine/src/test/java/org/apache/ignite/internal/sql/engine/planner/CastResolutionTest.java # modules/storage-api/src/testFixtures/java/org/apache/ignite/internal/storage/index/AbstractHashIndexStorageTest.java # modules/storage-page-memory/src/main/java/org/apache/ignite/internal/storage/pagememory/mv/AbstractPageMemoryMvPartitionStorage.java
PakhomovAlexander
approved these changes
Feb 27, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Thank you for submitting the pull request.
To streamline the review process of the patch and ensure better code quality
we ask both an author and a reviewer to verify the following:
The Review Checklist
- There is a single JIRA ticket related to the pull request.
- The web-link to the pull request is attached to the JIRA ticket.
- The JIRA ticket has the Patch Available state.
- The description of the JIRA ticket explains WHAT was made, WHY and HOW.
- The pull request title is treated as the final commit message. The following pattern must be used: IGNITE-XXXX Change summary where XXXX - number of JIRA issue.
Notes