Skip to content

Commit

Permalink
chore: Initial work on SingleProject Migration
Browse files Browse the repository at this point in the history
  • Loading branch information
morning4coffe-dev committed Aug 14, 2024
1 parent 95220b5 commit bd27dc7
Show file tree
Hide file tree
Showing 159 changed files with 1,301 additions and 1,885 deletions.
83 changes: 83 additions & 0 deletions src/.github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
name: 🐞 Bug
title: '[BUG] <title>'
description: File a bug report
labels: ["bug", "to verify"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! Please make sure to add as much detail as you can.
- type: textarea
id: description
attributes:
label: Description
description: Please give a detailed description of the issue that you're seeing. You can add screenshots and videos as well.
placeholder: Tell us what you see!
validations:
required: true
- type: textarea
id: repro-steps
attributes:
label: Steps to Reproduce
description: Describe all the steps we need to take to show the behavior that you have observed. Also, include what you expected to happen and what did actually happen.
placeholder: |
1. Create a File > New App
2. Add a `Button` like so: `<Button Text="this is a bug" />`
3. Click the added button and observe the bug 🐞
Expected outcome: a bug was added
Actual outcome: a ladybug appeared
validations:
required: true
- type: dropdown
id: platform-with-bug
attributes:
label: Platform with bug
description: What Platform is this bug affecting?
options:
- Core
- Android
- iOS
- MacCatalyst
- Windows
- Skia
- WebAssembly
- Other
validations:
required: true

- type: dropdown
id: platforms-affected
attributes:
label: Affected platforms
description: Select all or any platform that you see this issue on. This helps us determine if it's something platform-specific or in the core. If you were only able to test on 1 platform, please check the last option to inform us about that.
multiple: true
options:
- Android
- iOS
- MacOS
- MacCatalyst
- Windows
- GTK
- Linux Framebuffer
- WPF
- Skia Desktop
- WebAssembly
- Other
- I was *not* able test on other platforms
validations:
required: true

- type: textarea
id: workaround
attributes:
label: Did you find any workaround?
description: Did you find any workaround for this issue? This can unblock other people while waiting for this issue to be resolved or even give us a hint on how to fix this.

- type: textarea
id: logs
attributes:
label: Relevant log output
description: Please copy and paste any relevant log output. This will be auomatically formatted into code, so no need for back ticks.
render: shell
1 change: 1 addition & 0 deletions src/.github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
39 changes: 39 additions & 0 deletions src/.github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Feature Request
description: Suggest an idea for this project
labels: ["enhancement"]
assignees: []
body:
- type: markdown
attributes:
value: |
Fill in this template with some detail. A detailed description, perhaps supported with some screenshots, mockups, and a (public) API design in pseudo-code.
- type: textarea
id: description
attributes:
label: Description
description: Please give us a detailed description of the feature that you envision. Focus on _what_ this feature does, over the _why_ you want this feature. What would be the end-result when implemented? Feel free to add any diagrams, (mocked up) screenshots, or other materials that support your story.
placeholder: I would love to have a button that I can make shiny. This is something that is supported on all the underlaying platforms.
validations:
required: true
- type: textarea
id: api-changes
attributes:
label: API Changes
description: Include a list of all API changes, additions, subtractions as would be required by your proposal. These APIs should be considered placeholders, so the naming is not as important as getting the concepts correct. If possible you should include some example (pseudo-)code of usage of your new API.
placeholder: |
```csharp
var button = new Button ();
button.MakeShiny = true; // new API
```
The MakeShiny API works even if the button is already visible.
validations:
required: true
- type: textarea
id: use-case
attributes:
label: Intended Use-Case
description: Provide a detailed example of where your proposal would be used and for what purpose. Focus on _why_ you want this feature instead of _what_ the feature does.
placeholder: I have a situation where I would really want a shiny button to make it stand out from the rest of the plain and boring buttons.
validations:
required: true
80 changes: 80 additions & 0 deletions src/.github/ISSUE_TEMPLATE/spec.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: Spec
description: An official specification for enhancements.
labels: ["enhancement"]
assignees: []
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to provide us with a detailed specification of your idea.
In a spec you will give a detailed and complete representation of the (public) APIs that are implemented as part of this change. Additionally please think about backwards compatibility, breaking changes, supported platforms and the difficulty.
- type: textarea
id: description
attributes:
label: Description
description: Provide a concise description of the feature and the motivation for adding it. This can be a modified version from the feature request prior to this.
validations:
required: true
- type: textarea
id: api-changes
attributes:
label: (Public) API Changes
description: Include a complete list of all API changes, additions, subtractions as would be required by your proposal.
value: |
# [ class ]
## Properties
| API | Description |
| ------------- | ------------- |
| [name] | Gets or sets [description]. |
## Events
| API | Description |
| ------------- | ------------- |
| [name] | [API documentation/description] |
validations:
required: true
- type: textarea
id: usage-scenarios
attributes:
label: Usage Scenarios
description: Give us a couple of scenarios that demonstrate how developers would consume the above APIs.
placeholder: |
# C# Example
```csharp
var thing = new MyNewControl();
thing.BeAwesome = true;
thing.Color = Colors.Cornsilk;
```
# XAML Example
```xaml
<MyNewControl x:Name="thing" BeAwesome="true" Color="Cornsilk" />
```
validations:
required: true
- type: textarea
id: backwards-compatibility
attributes:
label: Backward Compatibility
description: Please describe here anything in terms of backwards compatibility. Will there be breaking changes? Do we need to update dependencies to support this? What are the minimum supported API/OS levels? And lastly, are there any platforms that can't support this and why?
placeholder: |
Minimum API levels?
Breaking changes?
Unsupported platforms?
validations:
required: true
- type: dropdown
id: difficulty
attributes:
label: Difficulty
description: What do you feel will be the difficulty of this change all things considering? No exact science, just your gut feeling.
options:
- Low
- Medium
- High
validations:
required: true
Loading

0 comments on commit bd27dc7

Please sign in to comment.