Skip to content

Commit 73edb28

Browse files
committed
Add CONTRIBUTING note about javaParser bugs
1 parent 5530e4d commit 73edb28

File tree

2 files changed

+12
-1
lines changed

2 files changed

+12
-1
lines changed

CONTRIBUTING.MD

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,17 @@ Once done (or re-done after a release), you can simply:
1111

1212
# Note for `mutator` contributors
1313

14+
## Bug with JavaParser
15+
16+
We regularly encounter bugs with `JavaParser` upstream dependency. In such case, with or without a workaround, it would be beneficial to report the case to JavaParser.
17+
18+
Many issues are related with `LexicalPreservingPrinter`.
19+
20+
Typical cases are:
21+
22+
- https://github.com/javaparser/javaparser/issues/3924
23+
- https://github.com/javaparser/javaparser/issues/3936
24+
1425
## Unit-tests
1526

1627
Mutators are subject to many edge-cases, due to the complexity of syntaxes (including Java).

MUTATORS.generated.MD

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ languageLevel: jdk1.8
110110

111111
### [SimplifyStartsWith](java/src/main/java/eu/solven/cleanthat/engine/java/refactorer/mutators/SimplifyStartsWith.java)
112112

113-
PMD: [SimplifyStartsWith]("https://pmd.github.io/pmd-doc-6.55.0/pmd_rules_java_performance.html#simplifystartswith")
113+
PMD: [SimplifyStartsWith](https://pmd.github.io/pmd-doc-6.55.0/pmd_rules_java_performance.html#simplifystartswith)
114114

115115
Cleanthat own ID: SimplifyStartsWith
116116

0 commit comments

Comments
 (0)