92 строки
3.2 KiB
YAML
92 строки
3.2 KiB
YAML
name: Spec
|
|
description: An official specification for enhancements. Preferably follows after an approved feature request.
|
|
labels: ["proposal/open", "t/enhancement"]
|
|
assignees: []
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thank you for taking the time to provide us with a detailed specification of your idea. This "spec" preferably follows after an approved feature request, so make sure to have that first unless instructed otherwise.
|
|
|
|
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 to .NET MAUI. 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 = Color.Cornsilk;
|
|
```
|
|
|
|
# XAML Example
|
|
```xaml
|
|
<MyNewControl x:Name="thing" BeAwesome="true" Color="Cornsilk" />
|
|
```
|
|
|
|
## CSS Example
|
|
```css
|
|
MyNewControl {
|
|
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
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
By opening the issue you agree to follow this project's [Code of Conduct](https://github.com/dotnet/maui/blob/main/.github/CODE_OF_CONDUCT.md)
|