Skip to content

Commit

Permalink
ci: add ISSUE_TEMPLATES
Browse files Browse the repository at this point in the history
  • Loading branch information
BioPhoton authored Oct 12, 2024
2 parents 22c3a3c + 149a691 commit 41bf879
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 0 deletions.
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Bug Report
description: File a bug report
title: 'Bug report'
labels: ['🐛 bug']
body:
- type: markdown
attributes:
value: Please provide all relevant information in order for us to be able to identify and fix the issue as soon as possible.
- type: textarea
id: current-behaviour
attributes:
label: What happened?
description: Here you can describe the issue you are facing.
placeholder: e.g. When I use the --help option, no output appears.
validations:
required: true
- type: textarea
id: expected-behaviour
attributes:
label: What would you expect to happen?
description: Please describe what you expected to happen.
placeholder: e.g. I expected to see a help message with all available arguments in stdout.
validations:
required: false
- type: textarea
id: how-to-reproduce
attributes:
label: What steps did you take?
description: Please provide a step-by-step guide on how to reproduce this issue.
validations:
required: true
- type: input
id: package-version
attributes:
label: Code PushUp package version
description: What version of `@push-based/nx-verdaccio` packages are you using? (check with `npm list @push-based/nx-verdaccio`)
- type: dropdown
id: os
attributes:
label: What operation system are you on?
multiple: false
options:
- Linux
- Windows
- MacOS
validations:
required: true
- type: input
id: node-version
attributes:
label: Node version
description: What Node version are you running? (check with `node -v`)
placeholder: e.g. 20.0.0
validations:
required: false
- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be automatically formatted into code.
render: shell
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: true
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Feature request
description: Add a request for a new feature or a change
title: 'Feature request'
body:
- type: markdown
attributes:
value: Please provide a concise set of requirements, so that we can process your request as soon as possible.
- type: textarea
id: user-story
attributes:
label: User story
description: Here you can phrase your request in a user story format which highlights the added value of the requested feature or change.
placeholder: e.g. As a Code PushUp user, I want to <request>, so that <added value>.
validations:
required: true
- type: textarea
id: acceptance-criteria
attributes:
label: Acceptance criteria
description: Please list a set of criteria to help us determine whether the scope of the request was fully addressed.
placeholder: |
For example:
- [ ] All packages have a comprehensive documentation in place.
- [ ] Cross references to relevant models or files are added as links.
validations:
required: true
- type: textarea
id: implementation-details
attributes:
label: Implementation details
description: If there are any implementation details you would want to point out, feel free to do so here.
placeholder: e.g. A link to a 3rd-party library, relevant article, expected flow details, wireframes highlighting the change or other.

0 comments on commit 41bf879

Please sign in to comment.