[doc] Add github issue templates

Refs #2249
This commit is contained in:
Andreas Dangel 2020-02-13 18:40:25 +01:00
parent 542097f5b6
commit ae9dec9c5e
6 changed files with 120 additions and 3 deletions

View File

@ -1,20 +1,39 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: ''
---
<!-- Please, prefix the report title with the language it applies to within brackets, such as [java] or [apex].
If not specific to a language, you can use [core]. -->
<!-- NB: issues about the rule designer should be opened at https://github.com/pmd/pmd-designer/issues -->
**Affects PMD Version:**
**Rule:**
Make sure, to test with the latest PMD version.
**Description:**
A clear and concise description of what the bug is.
**Exception Stacktrace:**
```
# Copy-paste the stack trace here
```
**Code Sample demonstrating the issue:**
```
```
**Steps to reproduce:**
1. Compile the project: `mvn verify`
2. Run PMD: `run.sh pmd -d src -f xml -R ruleset.xml`
**Running PMD through:** *[CLI | Ant | Maven | Gradle | Designer | Other]*
<!-- If relevant, also include your JDK and OS information, e.g. for ClassNotFoundException, LinkageError, reflection failures, etc. -->

8
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: PMD Designer Issues
url: https://github.com/pmd/pmd-designer/issues
about: Issues about the rule designer
- name: PMD Eclipse Plugin Issues
url: https://github.com/pmd/pmd-eclipse-plugin/issues
about: Issues about the PMD Eclipse Plugin

View File

@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''
---
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context about the feature request here.

27
.github/ISSUE_TEMPLATE/new_rule.md vendored Normal file
View File

@ -0,0 +1,27 @@
---
name: New Rule
about: You have an idea for a new rule? Great!
title: ''
labels: new-rule
assignees: ''
---
<!-- Please, prefix the report title with the language it applies to within brackets, such as [java] or [apex] -->
**Proposed Rule Name:**
**Proposed Category:** One of [Best Practices | Code Style | Design | Documentation | Error Prone | Multithreading | Performance | Security]
**Description:**
**Code Sample:** This should include code, that should be flagged by the rule. If possible, the "correct" code
according to this new rule should also be demonstrated.
```
```
**Possible Properties:**
* Should this rule be customizable via properties?

14
.github/ISSUE_TEMPLATE/question.md vendored Normal file
View File

@ -0,0 +1,14 @@
---
name: Question
about: Feel free to ask any question about PMD and its usage
title: ''
labels: question
assignees: ''
---
<!-- Have a look at https://github.com/pmd/pmd/issues?utf8=%E2%9C%93&q=label%3Aa%3Aquestion if there is already
a similar question -->
**Description:**

View File

@ -0,0 +1,29 @@
---
name: Rule violation
about: Let us know about a false positive/false negative
title: ''
labels: bug
assignees: ''
---
<!-- Please, prefix the report title with the language it applies to within brackets, such as [java] or [apex] -->
**Affects PMD Version:**
**Rule:**
**Description:**
**Code Sample demonstrating the issue:**
```
```
**Expected outcome:**
* Does PMD report a violation, where there shouldn't be one? -> false-positive
* Is PMD missing to report a violation, where there should be one? -> false-negative
**Running PMD through:** *[CLI | Ant | Maven | Gradle | Designer | Other]*