Skip to content

Commit

Permalink
feat(github): new ISSUE_TEMPLATE
Browse files Browse the repository at this point in the history
[skip ci]
  • Loading branch information
vogloblinsky committed Jul 14, 2021
1 parent 125641b commit d8722c2
Showing 1 changed file with 56 additions and 54 deletions.
110 changes: 56 additions & 54 deletions .github/ISSUE_TEMPLATE/bug_report.md
@@ -1,57 +1,59 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: 'Type: Bug'
assignees: vogloblinsky

about: Create a report to help us improve Compodoc
title: '[BUG] '
labels: [Bug]
assignees:
- vogloblinsky
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: textarea
id: what-happened
attributes:
label: Overview of the issue
description: explain the issue, if an error is being thrown a stack trace helps
validations:
required: true
- type: textarea
id: global-informations
attributes:
label: Global informations
description: Operating System, Node.js, npm, Angular, Compodoc version(s)
validations:
required: true
- type: textarea
id: sourcecode
attributes:
label: Sourcecode
description: If possible sourcecode of the file where it breaks
validations:
required: false
- type: textarea
id: logs
attributes:
label: Terminal logs
description: If possible your terminal logs before the error
validations:
required: false
- type: textarea
id: reproduce
attributes:
label: Reproduce the error
description: an unambiguous set of steps to reproduce the error, or link to a github repository
validations:
required: false
- type: textarea
id: suggest
attributes:
label: Suggest a Fix
description: if you can't fix the bug yourself, perhaps you can point to what might be causing the problem (line of code or commit)
validations:
required: false
- type: markdown
attributes:
value: |
Love compodoc? Please consider supporting our collective : 👉 https://opencollective.com/compodoc/donate
---

<!--
> Please follow the issue template below for bug reports.
> For issue, start the label of the title with [BUG]
-->

##### **Overview of the issue**

<!-- explain the issue, if an error is being thrown a stack trace helps -->

##### **Operating System, Node.js, npm, compodoc version(s)**

<!-- provide all information we need -->

##### **Angular configuration, a `package.json` file in the root folder**

<!-- This is mandatory for bug reports. This will help us to replicate the scenario. -->

##### **Compodoc installed globally or locally ?**

<!-- provide all information we need -->

##### **If possible sourcecode of the file where it breaks**

<!-- provide all information we need -->

##### **If possible your terminal logs before the error**

<!-- provide all information we need -->

##### **Motivation for or Use Case**

<!-- explain why this is a bug for you -->

##### **Reproduce the error**

<!-- an unambiguous set of steps to reproduce the error. -->

##### **Related issues**

<!-- has a similar issue been reported before? -->

##### **Suggest a Fix**

<!-- if you can't fix the bug yourself, perhaps you can point to what might be
causing the problem (line of code or commit) -->

<!-- Love compodoc? Please consider supporting our collective:
👉 https://opencollective.com/compodoc/donate -->

0 comments on commit d8722c2

Please sign in to comment.