[doc] Update issue template for bug reports and rule violations
This commit is contained in:
6
.github/ISSUE_TEMPLATE/bug_report.md
vendored
6
.github/ISSUE_TEMPLATE/bug_report.md
vendored
@ -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]*
|
||||
|
||||
|
3
.github/ISSUE_TEMPLATE/rule_violation.md
vendored
3
.github/ISSUE_TEMPLATE/rule_violation.md
vendored
@ -12,6 +12,9 @@ assignees: ''
|
||||
|
||||
**Rule:**
|
||||
|
||||
Please provide the rule name and a link to the rule documentation:
|
||||
<https://pmd.github.io/latest/pmd_rules_XXX_XXX.html#XXX>
|
||||
|
||||
**Description:**
|
||||
|
||||
**Code Sample demonstrating the issue:**
|
||||
|
Reference in New Issue
Block a user