Skip to content

Commit

Permalink
chore: issue templates (#53)
Browse files Browse the repository at this point in the history
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
  • Loading branch information
jkowalleck authored Mar 29, 2024
1 parent 4c1de92 commit 735e8d3
Show file tree
Hide file tree
Showing 3 changed files with 93 additions and 0 deletions.
34 changes: 34 additions & 0 deletions .github/ISSUE_TEMPLATE/ValidationError-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: ValidationError report
about: Report a ValidationError to help us improve
title: "[ValidationError]"
labels: ValidationError
assignees: ''

---

## To Reproduce

Steps to reproduce the behavior:

1. How was _@cyclonedx/yarn-plugin-cyclonedx_ called?
<!-- e.g. `yarn cyclonedx --production ...` -->
2. What kind of evidence was processed?
<!-- upload a complete project or set of `package.json` and `yarn.lock` to this issue, or a pastebin of you choice and put the link here. -->
3. Error report:
<!-- upload the complete output to this issue, or a pastebin of you choice and put the link here. -->
4. Expected result:
<!-- run the original call again
with parameters `-vvv --no-validate --output-reproducible --output-file=-`,
then upload all output to this issue, or to a pastebin of you choice and put the link here. -->

## Environment

- _@cyclonedx/yarn-plugin-cyclonedx_ version: <!-- e.g. `1.0.0-alpha+4c1de92` -->
- yarn version: <!-- get via `yarn -v` -->
- Node version: <!-- get via `node --version` -->
- OS: <!-- e.g. windows 11, ubuntu linux, ... -->

## Additional context

Add any other context about the problem here.
35 changes: 35 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug report
about: Create a report to help us improve
title: "[BUG]"
labels: bug
assignees: ''

---

## Describe the bug

A clear and concise description of what the bug is.

## To Reproduce

Steps to reproduce the behavior

## Expected behavior

A clear and concise description of what you expected to happen.

## Screenshots or output-paste

If applicable, add screenshots or past the output to help explain your problem.

## Environment

- _@cyclonedx/yarn-plugin-cyclonedx_ version: <!-- e.g. `1.0.0-alpha+4c1de92` -->
- yarn version: <!-- get via `yarn -v` -->
- Node version: <!-- get via `node --version` -->
- OS: <!-- e.g. windows 11, ubuntu linux, ... -->

## Additional context

Add any other context about the problem here.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
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 or screenshots about the feature request here.

0 comments on commit 735e8d3

Please sign in to comment.