Skip to content

[doc] Review rule writing documentation for PMD 7#4762

Merged
adangel merged 5 commits into
pmd:masterfrom
adangel:issue-2511-doc-rules
Jan 12, 2024
Merged

[doc] Review rule writing documentation for PMD 7#4762
adangel merged 5 commits into
pmd:masterfrom
adangel:issue-2511-doc-rules

Conversation

@adangel

@adangel adangel commented Dec 7, 2023

Copy link
Copy Markdown
Member

Describe the PR

  • added doc about reporting violations including some notes for usage of the placeholders ({0} or ${propertyName}).
  • The documentation is not complete, but I gave some pointers, what is missing (node stream traversal, using metrics, using type res)

Related issues

Ready?

  • Added unit tests for fixed bug/feature
  • Passing all unit tests
  • Complete build ./mvnw clean verify passes (checked automatically by github actions)
  • Added (in-code) documentation (if needed)

@adangel adangel added the in:documentation Affects the documentation [doc] label Dec 7, 2023
@adangel adangel added this to the 7.0.0 milestone Dec 7, 2023
@adangel adangel mentioned this pull request Dec 7, 2023
55 tasks
@ghost

ghost commented Dec 7, 2023

Copy link
Copy Markdown
1 Message
📖 No regression tested rules have been changed.

Generated by 🚫 Danger

Comment thread docs/pages/pmd/userdocs/extending/writing_java_rules.md
Comment thread docs/pages/pmd/userdocs/extending/writing_java_rules.md Outdated
@adangel adangel merged commit 661d76c into pmd:master Jan 12, 2024
@adangel adangel deleted the issue-2511-doc-rules branch January 12, 2024 08:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

in:documentation Affects the documentation [doc]

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[doc] Review guides for writing java/xpath rules for correctness with PMD 7

1 participant