Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Issue Template #527

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .github/ISSUE_TEMPLATE/blank_issue.md

This file was deleted.

69 changes: 69 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Bug Report
description: File a bug report to help us improve
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: dropdown
id: software
attributes:
label: Software
description: What software are you referring to?
multiple: true
options:
- Desktop Application
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably add the other extensions like Sublime / Raycast.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the other extensions, can you double-check if I missed anything/should remove anything?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not the repo where bug reports should be. That is why we have the link to our support repo in the config file.

So we don't need this bug report. We only need 1 general issue template and then we can keep the config file where people can go to report bugs or feature requests

- Pieces OS
- Web Extension
- VS Code
- JetBrains
- Obsidian
- Visual Studio
- Raycast
- JupyterLab
- Pieces CLI
- Microsoft Teams
- Sharing Web App
- Sublime Text
- Azure Data Studio
- Marketing Site (pieces.app)
- Blog (code.pieces.app/blog)
- Release Notes (code.pieces.app/updates)
default: 0
validations:
required: true
- type: dropdown
id: os
attributes:
label: Operating System / Platform
description: What operating system / platform are you using?
options:
- macOS
- Windows
- Linux
- Web
default: 0
validations:
required: true
- type: input
id: pieces-os-version
attributes:
label: Your Pieces OS Version
description: Add the version of Pieces OS installed in your system
validations:
required: true
- type: checkboxes
id: early_access_program
attributes:
label: Early Access Program
description: Is this issue related to a feature in our Early Access Program?
options:
- label: Yes, this is related to an Early Access Program feature.
- type: textarea
id: description
attributes:
label: Kindly describe the bug and include as much detail as possible on what you were doing so we can reproduce the bug.
description: Also tell us, what did you expect to happen?
placeholder: Tell us what you see!
validations:
required: true
5 changes: 0 additions & 5 deletions .github/ISSUE_TEMPLATE/config.yml

This file was deleted.

20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this could become the only issue template that we actually use. Im not sure if Feature Request is the best name for this though

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed the name to Enhancement, lmk what you think