diff --git a/docs/pages/pmd/userdocs/extending/rule_guidelines.md b/docs/pages/pmd/userdocs/extending/rule_guidelines.md index 91f03f6dba..d752ed5efd 100644 --- a/docs/pages/pmd/userdocs/extending/rule_guidelines.md +++ b/docs/pages/pmd/userdocs/extending/rule_guidelines.md @@ -27,9 +27,12 @@ For instance, let’s take the ExplicitCallToGC rule (“Do not explicitly trigg ## Code formatting -We try to keep a consistent code formatting through out PMD code base to ensure an easier maintenance and also make the diff send to the mailing list as readable as possible. +We try to keep a consistent code formatting through out PMD code base to ensure an easier maintenance and also make +the pull request as readable as possible. -In order to ensure this, we use a PMD specific Eclipse formatter configuration: **tools/config/eclipse-code-formatter-settings.xml**. Please do not forget to uses it before committing or any source code! +In order to ensure this, we use a PMD specific Eclipse formatter configuration, which is maintained in a +separate project - "build-tools": [eclipse-code-formatter.xml](https://github.com/pmd/build-tools/blob/master/eclipse/pmd-eclipse-code-formatter.xml). +Please do not forget to use it before committing or any source code! ## Correctness