From 40d7d27665659bf12b9aece15cd66b8da6cb76e1 Mon Sep 17 00:00:00 2001 From: Andreas Dangel Date: Sat, 21 Mar 2020 11:44:22 +0100 Subject: [PATCH] [doc] Update issue template for bug reports and rule violations --- .github/ISSUE_TEMPLATE/bug_report.md | 6 ++++-- .github/ISSUE_TEMPLATE/rule_violation.md | 3 +++ 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index f667e0584b..0bd4d2f99f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -31,8 +31,10 @@ A clear and concise description of what the bug is. **Steps to reproduce:** -1. Compile the project: `mvn verify` -2. Run PMD: `run.sh pmd -d src -f xml -R ruleset.xml` +Please provide detailed steps for how we can reproduce the bug. + +1. ... (e.g. if you're using maven: `mvn clean verify`) +2. ... **Running PMD through:** *[CLI | Ant | Maven | Gradle | Designer | Other]* diff --git a/.github/ISSUE_TEMPLATE/rule_violation.md b/.github/ISSUE_TEMPLATE/rule_violation.md index 3a13db905b..92404bd43b 100644 --- a/.github/ISSUE_TEMPLATE/rule_violation.md +++ b/.github/ISSUE_TEMPLATE/rule_violation.md @@ -12,6 +12,9 @@ assignees: '' **Rule:** +Please provide the rule name and a link to the rule documentation: + + **Description:** **Code Sample demonstrating the issue:**