Skip to content

Commit

Permalink
chores: improve github issue templates (#23)
Browse files Browse the repository at this point in the history
this changeset is to upgrade the github issue templates and a bit of a
clean up.
  • Loading branch information
kosperera authored Mar 4, 2024
1 parent e9ef809 commit d02939b
Show file tree
Hide file tree
Showing 6 changed files with 117 additions and 62 deletions.
8 changes: 2 additions & 6 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,6 @@
"bierner.markdown-checkbox",
"bierner.jsdoc-markdown-highlighting",
"ms-vscode.wordcount",
// TOML, YAML, et al.
"tamasfe.even-better-toml",
"redhat.vscode-yaml",
"editorconfig.editorconfig",
// Other
"albert.tabout",
"bierner.comment-tagged-templates"
Expand Down Expand Up @@ -76,8 +72,8 @@
},
// Use 'updateContentCommand' to run commands after the container is successfully created.
"updateContentCommand": {
"docsify": "bun install --global docsify-cli",
"deno": "curl -fsSL https://deno.land/install.sh | sh"
"install_docsify": "bun install --global docsify-cli",
"install_deno": "curl -fsSL https://deno.land/install.sh | sh"
},
// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": {
Expand Down
71 changes: 71 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
name: Bug
description: Create a report to help us improve
labels: ["bug", "triage"]
assignees:
- kosperera
body:
- type: textarea
id: what-happened
attributes:
label: What happened?
description: Tell us, what happen and what you see?
placeholder: |
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
id: what-expected
attributes:
label: What did you expected?
description: Tell us, what did you expect to happen?
placeholder: |
Give us a clear and concise description of what you expected to happen.
- type: dropdown
id: where-happened
attributes:
label: What devices are you seeing the problem on?
multiple: true
options:
- Large Desktop
- Laptop
- Tablet
- Smartphone
validations:
required: true
- type: textarea
id: what-version
attributes:
label: Additional context
description: Provide us a bit more info about the devices?
placeholder: |
- Device: [e.g. iPhone6, Samsung Galaxy]
- OS: [e.g. iOS 16.2.3298]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
validations:
required: true
- type: textarea
id: how-happened
attributes:
label: How it happened?
description: Tell us, any additional context about the problem here.
placeholder: |
Add any other context about the problem here.
- 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, so no need for backticks.
render: shell
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
37 changes: 0 additions & 37 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

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: false
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Feature request
description: Suggest an idea for this project
labels: ["bug", "triage"]
assignees:
- kosperera
body:
- type: textarea
id: what
attributes:
label: What?
description: Is your feature request related to a problem? Please describe.
placeholder: |
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: true
- type: textarea
id: what-expected
attributes:
label: Behavior?
description: Describe the solution you'd like.
placeholder: |
A clear and concise description of what you want to happen.
- type: textarea
id: what-version
attributes:
label: Alternatives?
description: Describe alternatives you've considered.
placeholder: |
A clear and concise description of any alternative solutions or features you've considered.
- type: textarea
id: how-happened
attributes:
label: Additional context
placeholder: |
Add any other context or screenshots about the feature request here.
- type: checkboxes
id: terms
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](CODE_OF_CONDUCT.md)
options:
- label: I agree to follow this project's Code of Conduct
required: true
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

0 comments on commit d02939b

Please sign in to comment.