hiifong/pmd
1
0
Fork 0
forked from phoedos/pmd
Code Pull Requests Activity

Update release notes, refs #782

Browse Source
This commit is contained in:
Andreas Dangel
2018-01-01 16:33:35 +01:00
parent f4577f9e14
commit baee671c4a
1 changed files with 21 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/pages/release_notes.md
View File

@ -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 <https://pmd.github.io/latest/>.
### 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