apache / apache/maven-checkstyle-plugin
[MCHECKSTYLE-386] Method 'isViolation' has a unfortunate name
- Dominant language
- Java
- Stars
- 97
- Forks
- 67
- Avg merge
- 14h 50m
- Merged PRs (30d)
- 6
Description
**[Benjamin Marwell](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=mampf86)** opened **[MCHECKSTYLE-386](https://issues.apache.org/jira/browse/MCHECKSTYLE-386?redirect=false)** and commented
The method `isViolation` checks if a violation should be reported or not according to the user configuration. Therefore, it does not change the violation to be a violation. Instead, it should reflect that behaviour.
https://github.com/apache/maven-checkstyle-plugin/pull/17#discussion_r357680549
---
**Affects:** 3.1.0
Contributor guide
No contributing guide indexed for this repository
Research direction
Search the project for the `isViolation` method and its call sites, then read the surrounding implementation and the linked discussion for the intended naming. Rename the method to reflect that it decides whether a violation should be reported, update its references, and run the relevant project tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- build-system
- Issue type
- Refactor
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100