hexagonal-architecture-java
hexagonal-architecture-java copied to clipboard
Use Convention Over Configuration (CoC) Instead of Explicit PMD Rules
Description
This Pull Request removes the explicit PMD ruleset configuration (pmd-ruleset.xml) and opts to rely on the default PMD configurations.
Key Reasons:
- Simplification: By following the principle of "Convention Over Configuration," we reduce the need for custom rule management.
- Best Practices: Default PMD settings align with commonly accepted standards and practices out-of-the-box.
-
Maintenance: Eliminates the overhead of maintaining a separate
pmd-ruleset.xmlfile.
Changes Made
- Deleted
pmd-ruleset.xml. - Updated
pom.xmlto remove references to the deleted ruleset.
Impacts
- Custom rules defined in
pmd-ruleset.xmlwill no longer apply. - Builds and analyses will follow PMD's default behavior, ensuring alignment with community standards.
How to Test
- Run
mvn pmd:checkto verify builds and PMD analysis with default settings. - Ensure the output aligns with expected code quality and rule coverage.