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.

Sign up for GitHub

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

chore: upgrade issues templates #11

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

chore: upgrade issues templates #11

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0764c25
chore: upgrade issues templates
Olyno Feb 1, 2023
8ac7ade
chore: switch from input to textarea for descriptions
Olyno Feb 2, 2023
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
39 changes: 0 additions & 39 deletions .github/ISSUE_TEMPLATE/1.Bug_report.md
View file
Open in desktop

This file was deleted.

96 changes: 96 additions & 0 deletions .github/ISSUE_TEMPLATE/1.Bug_report.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,96 @@
name: Bug Report
description: Create a bug report for one of the supabase repos or examples.
labels: ['bug', 'triage']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!

- type: input
Olyno marked this conversation as resolved.
Show resolved Hide resolved
id: description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true

- type: textarea
id: reproduction
attributes:
label: To Reproduce
description: Steps to reproduce the behavior, please provide code snippets or a repository
placeholder: |
1. Go to '…'
2. Click on '…'
3. Scroll down to '…'
4. See error
validations:
required: true

- type: input
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true

- type: dropdown
id: system-os
attributes:
label: 'System information: OS'
description: Which operating system are you using?
options:
- Linux
- Mac OS
- Windows
validations:
required: true

- type: dropdown
id: system-browser
attributes:
label: What browser are you seeing the problem on? (if applies)
options:
- Chrome
- Firefox
- Safari
- Other
validations:
required: false

- type: input
Copy link

Choose a reason for hiding this comment

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

Same as below. Not all issues have to do with supabase-js

id: supabase-js-version
attributes:
label: Supabase JS version
description: What version of supabase-js are you using?
validations:
required: true

- type: dropdown
Copy link

Choose a reason for hiding this comment

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

Am I right that the user has to specify a runtime? The issue might not even related to it, but rather the supabase dashboard or some api repository.

Copy link
Author

Choose a reason for hiding this comment

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

You're right, i tried to keep the templates that were there, so that only the style changes, and potentially add other information (such as the choice of runtime).

Do you think we should modify these new templates so that they are more representative of Supabase's work? Including, for example, a dropdown to choose what the issue is about (supabase-js, supabase-flutter....)?

Copy link

Choose a reason for hiding this comment

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

It depends on where the template gets applied to. In the flutter repos, we currently have our own issue templates. All flutter related issues should be collected there and not in the supabase/supabase repo. So I don't think it makes sense to add a client library dropdown. I think the template here should be very general. Repository specific information should be specified in a template per repository. What do you think?

Copy link
Author

Choose a reason for hiding this comment

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

Sounds good, pushing an update asap

id: system-runtime
attributes:
label: What runtime are you seeing the problem on?
options:
- Node
- Deno
- Bun
validations:
required: true

- type: input
id: runtime-version
attributes:
label: Runtime version
description: What version of your runtime are you using?
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/2.Improve_docs.md
View file
Open in desktop

This file was deleted.

40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/2.Improve_docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: Improve documentation
description: Suggest an improvement to our documentation
labels: ['documentation', 'triage']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this documentation feedback!

- type: input
id: link
attributes:
label: Link to page
description: Add a link to the page which needs improvement (if relevant)
validations:
required: false

- type: textarea
id: description
attributes:
label: Describe the problem
description: Is the documentation missing? Or is it confusing? Why is it confusing?
validations:
required: true

- type: input
id: improvement
attributes:
label: Describe the improvement
description: A clear and concise description of the improvement.
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context or screenshots that help clarify your question.
validations:
required: false
15 changes: 0 additions & 15 deletions .github/ISSUE_TEMPLATE/3.Create_a_chore.md
View file
Open in desktop

This file was deleted.

24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/3.Create_a_chore.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Create a chore
description: Changes to build processes, tools, refactors.
labels: ['chore', 'triage']
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this chore request!

- type: input
id: description
attributes:
label: Describe the chore
description: A clear and concise description of what the chore is.
validations:
required: true

- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false