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

chore: Adjust GitHub Templates #1

Merged
merged 1 commit into from
Dec 11, 2024
Merged
Show file tree
Hide file tree
Changes from all 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
99 changes: 41 additions & 58 deletions .github/ISSUE_TEMPLATE/bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,116 +1,99 @@
name: Bug Report
description: Report a bug encountered while developing with Uno
description: Report a bug encountered while using Uno Platform Studio.
labels: [kind/bug, triage/untriaged, difficulty/tbd]
body:
- type: textarea
id: current-behavior
attributes:
label: Current behavior
description: Describe how the issue manifests
description: Describe how the issue manifests while using Uno Platform Studio.

- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: Describe what the desired behavior should be.
description: Describe what the desired behavior should be when using Uno Platform Studio.

- type: textarea
id: how-to-reproduce
attributes:
label: How to reproduce it (as minimally and precisely as possible)
description: |
Please provide a **MINIMAL REPRO PROJECT** and the **STEPS TO REPRODUCE**

To create a minimal reproduction project:
Please provide the **STEPS TO REPRODUCE** and any necessary details about the issue:

- Create an Uno app through:
- `dotnet new install Uno.Templates` and `dotnet new unoapp`
- or through the [Visual Studio extension](https://platform.uno/docs/articles/get-started-vs-2022.html)
- Make sure to add the least code possible to demonstrate the issue
- Keep all project heads, even if the platforms are seemingly not relevant to your issue
- Remove all the `obj/bin` folders and zip the folder.
- Attach the zip file to the issue

If the issue is visible on WebAssembly and uses only XAML:

- Visit https://playground.platform.uno
- Add your code and data context as needed
- Create a link and paste it here
- Which tool were you using? (Hot Design™, Hot Reload, or Design-to-Code)
- Steps to reproduce the issue.
- Provide any code snippets, screenshots, videos or additional context that would help us understand how to reproduce the issue.

- type: textarea
id: workaround
attributes:
label: Workaround
description: Please provide steps to workaround this problem if possible
- type: dropdown
id: works-uwp-winui
attributes:
label: Works on UWP/WinUI
description: |
To make sure this is an Uno Platform specific issue, try running your sample application on Windows using the UWP or WinUI project. If it does not work on Windows either, it may be a Windows issue or it may be a documentation issue.
In this case, [open a discussion](https://github.com/unoplatform/uno/discussions) instead.
options:
- 'Yes'
- 'No'
description: Please provide steps to workaround this problem if possible.

- type: dropdown
id: environment
id: tools
attributes:
label: Environment
description: NuGet package(s)
label: Which tool(s) are affected?
multiple: true
options:
- Uno.UI / Uno.UI.WebAssembly / Uno.UI.Skia
- Uno.WinUI / Uno.WinUI.WebAssembly / Uno.WinUI.Skia
- Uno.SourceGenerationTasks
- Uno.UI.RemoteControl / Uno.WinUI.RemoteControl
- Other

- type: textarea
id: nuget-versions
attributes:
label: NuGet package version(s)
- Hot Design™
- Hot Reload
- Design-to-Code

- type: dropdown
id: platforms
attributes:
label: Affected platforms
multiple: true
options:
options:
- Desktop (Skia)
- Windows
- WebAssembly
- Android
- iOS
- macOS (AppKit)
- Mac Catalyst
- Skia (WPF)
- Skia (GTK on Linux/macOS/Windows)
- Skia (Linux Framebuffer)
- Windows
- Build tasks
- macOS (Catalyst)

- type: textarea
id: uno-sdk-version
attributes:
label: Uno.Sdk version
description: Specify the version of Uno.Sdk being used, as listed in the `global.json` file of your solution.

- type: dropdown
id: ide
attributes:
label: IDE
label: IDE used
multiple: true
options:
- Visual Studio 2022
- Visual Studio Code
- Visual Studio for Mac
- Rider Windows
- Rider macOS
- Visual Studio Code on Windows
- Visual Studio Code on macOS
- Visual Studio Code on Linux
- Rider on Windows
- Rider on macOS
- Rider on Linux

- type: input
id: ide-version
attributes:
label: IDE version
description: Specify the version of the IDE you were using.

- type: input
id: uno-platform-extension-version
attributes:
label: Uno Platform Extension version
description: Specify the version of the Uno Platform Extension you are using with your IDE.

- type: textarea
id: plugins
attributes:
label: Relevant plugins
description: For example, ReSharper version X
description: For example, ReSharper version X or any other tools affecting your workflow.

- type: textarea
id: additional-info
attributes:
label: Anything else we need to know?
description: We would love to know of any friction, apart from knowledge, that prevented you from sending in a pull-request
description: Provide any additional details or context that could help us investigate the issue.
7 changes: 5 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Questions
url: https://github.com/unoplatform/uno/discussions
about: 'For general questions about Uno, visit GitHub discussions'
url: https://github.com/unoplatform/studio/discussions
about: 'For general questions about Uno Platform Studio, visit the GitHub Discussions tab.'
- name: Support
url: https://platform.uno/uno-discord
about: 'For additional support, visit our Discord Server – where our engineering team and community will be happy to assist you.'
17 changes: 0 additions & 17 deletions .github/ISSUE_TEMPLATE/documentation-issue.md

This file was deleted.

21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-issue.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Documentation Issue
description: Report an issue with the Uno Platform Studio documentation.
labels: [kind/consumer-experience, kind/documentation, triage/untriaged, difficulty/tbd]
body:
- type: input
id: documentation-page
attributes:
label: On which page?
description: Provide the URL or title of the documentation page where you found the issue.

- type: textarea
id: documentation-problem
attributes:
label: What's wrong?
description: Describe the problem or issue with the documentation in detail.

- type: textarea
id: additional-feedback
attributes:
label: Any feedback?
description: Provide additional feedback, suggestions, or anything else we need to know.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/documentation-request.md

This file was deleted.

52 changes: 52 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
name: Documentation Request
description: Request an enhancement or clarification for the Uno Platform Studio documentation.
labels: [kind/consumer-experience, kind/documentation, triage/untriaged, difficulty/tbd]
body:
- type: textarea
id: documentation-request
attributes:
label: What do you need clarification or enhancement on?
description: Describe in detail the documentation topic or section that needs improvement or clarification.

- type: dropdown
id: documentation-concern
attributes:
label: What is your concern?
description: Select the topic related to your request.
multiple: true
options:
- Getting started with Uno Platform Studio
- Using Hot Design™
- Using Hot Reload
- Using Design-to-Code
- Supported platforms or tools
- Best practices or workflows
- Other (please specify)

- type: textarea
id: other-concern
attributes:
label: If "Other," please specify
description: Provide additional details if you selected "Other (please specify)" above.

- type: dropdown
id: documentation-platforms
attributes:
label: For which platform(s)?
description: |
**Note for Hot Design™:**
At the current stage of the Hot Design™ beta, only the **Desktop** platform is supported. Other platforms are undergoing stabilization for Hot Design support and will be available in future updates.
multiple: true
options:
- Desktop (Skia)
- Windows
- WebAssembly
- Android
- iOS
- macOS (Catalyst)

- type: textarea
id: additional-info
attributes:
label: Is there anything else we need to know?
description: Include any notes, further explanations, or references that might help contributors understand your request.
40 changes: 25 additions & 15 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -1,38 +1,48 @@
name: Enhancement Request
description: Suggest an enhancement to Uno Platform
description: Suggest an enhancement to Uno Platform Studio.
labels: [kind/enhancement, triage/untriaged, difficulty/tbd]
body:
- type: textarea
id: enhancement-description
attributes:
label: What would you like to be added
description: Describe in detail what is the feature or functionality you are missing
label: What feature or functionality would you like to see added?
description: Describe in detail what feature or functionality you feel is missing from Uno Platform Studio.

- type: textarea
id: enhancement-use-case
attributes:
label: Why is this needed
description: Describe the use case of this enhancement
label: Why is this enhancement needed?
description: Explain the use case or problem this enhancement would address and how it would improve your workflow.

- type: dropdown
id: enhancement-tools
attributes:
label: Which tool(s) does this enhancement relate to?
multiple: true
options:
- Hot Design
- Hot Reload
- Design-to-Code

- type: dropdown
id: enhancement-platforms
attributes:
label: For which platform
label: For which platform(s)?
description: |
**Note for Hot Design:**
At the current stage of the Hot Design™ beta, only the Desktop platform is supported. Other platforms are undergoing stabilization for Hot Design support and will be available in future updates.
For now, you can use the Desktop platform to create your UI with the runtime visual designer. Once you’re satisfied with your design, you can test the app on other platforms by launching it as you would normally.
multiple: true
options:
- Desktop (Skia)
- Windows
- WebAssembly
- Android
- iOS
- macOS (AppKit)
- Mac Catalyst
- Skia (WPF)
- Skia (GTK on Linux/macOS/Windows)
- Skia (Linux Framebuffer)
- Windows
- Build tasks
- macOS (Catalyst)

- type: textarea
id: enhancement-additional-info
attributes:
label: Anything else we need to know?
description: Notes for contributors, further explanations, or any other information
label: Is there anything else we need to know?
description: Include any notes, further explanations, or references that might help contributors understand your request.
Loading
Loading