hexagonal-architecture-java icon indicating copy to clipboard operation
hexagonal-architecture-java copied to clipboard

Use Convention Over Configuration (CoC) Instead of Explicit PMD Rules

Open Pankraz76 opened this issue 1 year ago • 0 comments

Description

This Pull Request removes the explicit PMD ruleset configuration (pmd-ruleset.xml) and opts to rely on the default PMD configurations.

Key Reasons:

  1. Simplification: By following the principle of "Convention Over Configuration," we reduce the need for custom rule management.
  2. Best Practices: Default PMD settings align with commonly accepted standards and practices out-of-the-box.
  3. Maintenance: Eliminates the overhead of maintaining a separate pmd-ruleset.xml file.

Changes Made

  • Deleted pmd-ruleset.xml.
  • Updated pom.xml to remove references to the deleted ruleset.

Impacts

  • Custom rules defined in pmd-ruleset.xml will no longer apply.
  • Builds and analyses will follow PMD's default behavior, ensuring alignment with community standards.

How to Test

  1. Run mvn pmd:check to verify builds and PMD analysis with default settings.
  2. Ensure the output aligns with expected code quality and rule coverage.

Pankraz76 avatar Jan 02 '25 16:01 Pankraz76