From baee671c4ad37e7949ec71325a97f4ba8942bd78 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Mon, 1 Jan 2018 16:33:35 +0100 Subject: [PATCH] Update release notes, refs #782 --- docs/pages/release_notes.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/docs/pages/release_notes.md b/docs/pages/release_notes.md index 728f13361b..99b21848eb 100644 --- a/docs/pages/release_notes.md +++ b/docs/pages/release_notes.md @@ -19,6 +19,26 @@ This is a bug fixing release. ### New and noteworthy +#### Additional information about the new introduced rule categories + +With the release of PMD 6.0.0, all rules have been sorted into one of the following eight categories: + +1. **Best Practices**: These are rules which enforce generally accepted best practices. +2. **Code Style**: These rules enforce a specific coding style. +3. **Design**: Rules that help you discover design issues. +4. **Documentation**: These rules are related to code documentation. +5. **Error Prone**: Rules to detect constructs that are either broken, extremely confusing or prone to runtime errors. +6. **Multithreading**: These are rules that flag issues when dealing with multiple threads of execution. +7. **Performance**: Rules that flag suboptimal code. +8. **Security**: Rules that flag potential security flaws. + +Please note, that not every category in every language may have a rule. There might be categories with no +rules at all, such as `category/java/security.xml`, which has currently no rules. +There are even languages, which only have rules of one category (e.g. `category/xml/errorprone.xml`). + +You can find the information about available rules in the generated rule documentation, available +at . + ### Fixed Issues * apex-errorprone @@ -26,6 +46,7 @@ This is a bug fixing release. * apex-security * [#788](https://github.com/pmd/pmd/issues/788): \[apex] Method chaining breaks ApexCRUDViolation * doc + * [#782](https://github.com/pmd/pmd/issues/782): \[doc] Wrong information in the Release Notes about the Security ruleset * [#794](https://github.com/pmd/pmd/issues/794): \[doc] Broken documentation links for 6.0.0 * java * [#783](https://github.com/pmd/pmd/issues/783): \[java] GuardLogStatement regression