Skip to content

Commit

Permalink
Merge pull request #12 from adrianbrs/issue-templates
Browse files Browse the repository at this point in the history
docs: add issue templates
  • Loading branch information
adrianbrs authored Sep 22, 2022
2 parents d0e915d + 869dad9 commit e70202b
Show file tree
Hide file tree
Showing 3 changed files with 177 additions and 0 deletions.
124 changes: 124 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
name: "\U0001F41B Bug Report"
description: "If something isn't working as expected \U0001F914"
labels: ['needs triage']
body:
- type: markdown
attributes:
value: |
## :warning: We use GitHub Issues to track bug reports and feature requests only related to `nest-oidc-provider` module, and not the `oidc-provider` package itself.
If you are not sure that your issue is a bug, you could [open a discussion](https://github.com/adrianbrs/nest-oidc-provider/discussions/new).
If your issue is related to the `oidc-provider` package, please visit oidc-provider's [repository](https://github.com/panva/node-oidc-provider).
**NOTE:** You don't need to answer questions that you know that aren't relevant.
---
- type: checkboxes
attributes:
label: 'Is there an existing issue for this?'
description: 'Please search [here](../issues?q=is%3Aissue) to see if an issue already exists for the bug you encountered'
options:
- label: 'I have searched the existing issues'
required: true

- type: textarea
validations:
required: true
attributes:
label: 'Current behavior'
description: 'How the issue manifests?'

- type: input
validations:
required: false
attributes:
label: 'Minimum reproduction code'
description: 'An URL to some Git repository/[StackBlitz](https://stackblitz.com/fork/github/nestjs/typescript-starter)/[CodeSandbox](https://codesandbox.io/s/github/nestjs/typescript-starter/tree/master) project that reproduces your issue. [Wtf is a minimum reproduction?](https://jmcdo29.github.io/wtf-is-a-minimum-reproduction)'
placeholder: 'https://github.com/...'

- type: textarea
attributes:
label: 'Steps to reproduce'
description: |
How the issue manifests?
You could leave this blank if you alread write this in your reproduction code
placeholder: |
1. `npm ci`
2. `npm start:dev`
3. See error...
- type: textarea
validations:
required: true
attributes:
label: 'Expected behavior'
description: 'A clear and concise description of what you expected to happend (or code)'

- type: markdown
attributes:
value: |
---
- type: checkboxes
attributes:
label: 'Package'
description: |
Which package (or packages) do you think your issue is related to?
options:
- label: '<code>oidc-provider</code>'
- label: '<code>nest-oidc-provider</code>'
- label: "I don't know. Or some 3rd-party package"
- label: 'Other (see below)'

- type: input
attributes:
label: 'Other package'
description: 'If your issue is related to some package that is not listed above, write its name here'

- type: input
attributes:
label: 'NestJS version'
description: |
Which version of `@nestjs/core` are you using?
**Tip**: Make sure that all of yours `@nestjs/*` dependencies are in sync!
placeholder: '8.1.3'

- type: textarea
validations:
required: true
attributes:
label: 'Packages versions'
description: |
You could leave your whole `package.json` dependencies list here, or just indicate which version of `@nestjs/*` you are using
**Tip**: run _npx nest info_
value: |
```json
```
- type: input
attributes:
label: 'Node.js version'
description: 'Which version of Node.js are you using?'
placeholder: '14.17.6'

- type: checkboxes
attributes:
label: 'In which operating systems have you tested?'
options:
- label: macOS
- label: Windows
- label: Linux

- type: markdown
attributes:
value: |
---
- type: textarea
attributes:
label: 'Other'
description: |
Anything else relevant? eg: Logs, OS version, IDE, package manager, etc.
**Tip:** You can attach images, recordings or log files by clicking this area to highlight it and then dragging files in
2 changes: 2 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
## To encourage contributors to use issue templates, we don't allow blank issues
blank_issues_enabled: false
51 changes: 51 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
name: "\U0001F680 Feature Request"
description: "I have a suggestion \U0001F63B!"
labels: ['type: enhancement', 'needs triage']
body:
- type: markdown
attributes:
value: |
## :warning: We use GitHub Issues to track bug reports and feature requests only related to `nest-oidc-provider` module, and not the `oidc-provider` package itself.
If you are not sure that your issue is a bug, you could [open a discussion](https://github.com/adrianbrs/nest-oidc-provider/discussions/new).
If your issue is related to the `oidc-provider` package, please visit oidc-provider's [repository](https://github.com/panva/node-oidc-provider).
---
- type: checkboxes
attributes:
label: 'Is there an existing issue that is already proposing this?'
description: 'Please search [here](../issues?q=is%3Aissue) to see if an issue already exists for the feature you are requesting'
options:
- label: 'I have searched the existing issues'
required: true

- type: textarea
validations:
required: true
attributes:
label: 'Is your feature request related to a problem? Please describe it'
description: 'A clear and concise description of what the problem is'
placeholder: |
I have an issue when ...
- type: textarea
validations:
required: true
attributes:
label: "Describe the solution you'd like"
description: 'A clear and concise description of what you want to happen. Add any considered drawbacks'

- type: textarea
validations:
required: true
attributes:
label: 'Teachability, documentation, adoption, migration strategy'
description: 'If you can, explain how users will be able to use this and possibly write out a version the docs. Maybe a screenshot or design?'

- type: textarea
validations:
required: true
attributes:
label: 'What is the motivation / use case for changing the behavior?'
description: 'Describe the motivation or the concrete use case'

0 comments on commit e70202b

Please sign in to comment.