New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] [GSoC] Create the documentation about pmdtester #1290

Merged
merged 2 commits into from Aug 8, 2018

Conversation

Projects
None yet
3 participants
@djydewang
Member

djydewang commented Aug 7, 2018

This document briefly introduces pmdtester and how to run it locally.

@pmd-bot

This comment has been minimized.

Contributor

pmd-bot commented Aug 7, 2018

1 Message
📖 No java rules are changed!

Generated by 🚫 Danger

@adangel

That's great! I think, although it's short, it has the essential information.

What we need to add however is: Adding it to the sidebar, otherwise the page cannot be found.
Just add an entry in https://github.com/pmd/pmd/blob/master/docs/_data/sidebars/pmd_sidebar.yml#L307 under "Developer Documentation".

@@ -0,0 +1,17 @@
## Introduction
Pmdtester is a regression testing tool ensure that new problems and unexpected behaviors will not be introduced to PMD project after fixing an issue ,

This comment has been minimized.

@adangel

adangel Aug 7, 2018

Member

I'd phrase that sentence a bit different, so that sound more fluid (IMHO - I'm also no native speaker...):

Pmdtester is a regression testing tool that ensures no new problems and unexpected behaviors will be introduced to PMD after fixing an issue. It can also be used to verify, that new rules work as expected.

@@ -1,6 +1,13 @@
---

This comment has been minimized.

@adangel

adangel Aug 8, 2018

Member

👍 I forgot about the header. Glad you added it.

@adangel

adangel approved these changes Aug 8, 2018

@adangel adangel merged commit 01c622a into pmd:master Aug 8, 2018

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
danger/danger All green. Good on 'ya.
Details

adangel added a commit that referenced this pull request Aug 8, 2018

@adangel adangel added this to the 6.7.0 milestone Aug 8, 2018

@adangel

This comment has been minimized.

Member

adangel commented Aug 8, 2018

@djydewang Here's the snapshot version of the page: https://pmd.github.io/pmd/pmd_devdocs_pmdtester.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment