Skip to content

Commit f42a3ee

Browse files
newky2kjamesmontemagno
authored andcommitted
Created Issue_Templates for creating issues (xamarin#826)
* work on the templates * Added feature-request.md template
1 parent a3beded commit f42a3ee

File tree

3 files changed

+109
-0
lines changed

3 files changed

+109
-0
lines changed
Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: "[Bug] "
5+
labels: bug :bug:
6+
assignees: ''
7+
8+
---
9+
10+
<!-- Bug report best practices: https://github.com/xamarin/Essentials/wiki -->
11+
12+
### Description
13+
14+
### Steps to Reproduce
15+
16+
1.
17+
2.
18+
3.
19+
20+
### Expected Behavior
21+
22+
### Actual Behavior
23+
24+
### Basic Information
25+
26+
- Version with issue:
27+
- Last known good version:
28+
- IDE:
29+
- Platform Target Frameworks: <!-- All that apply -->
30+
- iOS: <!-- The version of the iOS SDK you are compiling against, e.g. 11.1 -->
31+
- Android: <!-- The version of the Android SDK you are compiling against, e.g. 7.1 -->
32+
- UWP: <!-- The version of the UWP SDK you are compiling against, e.g. 16299 -->
33+
- Android Support Library Version: <!-- if applicable -->
34+
- Nuget Packages:
35+
- Affected Devices:
36+
37+
### Screenshots
38+
39+
<!-- If the issue is a visual issue, please include screenshots showing the problem if possible -->
40+
41+
### Reproduction Link
42+
43+
<!-- Please upload or provide a link to a reproduction case -->
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for Essentials
4+
title: "[Enhancement] YOUR IDEA!"
5+
labels: feature-request
6+
assignees: ''
7+
8+
---
9+
10+
## Summary
11+
Please provide a brief summary of your proposal. Two to three sentences is best here.
12+
13+
## API Changes
14+
15+
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" code of usage of your new API. You should also provide details of the level of availability for the feature on each of the supported platforms.
16+
17+
e.g.
18+
19+
In order to facilitate the new Shiny Button api, a bool is added to the Button class. This is done as a bool because it is simpler to data bind and other reasons...
20+
21+
var button = new Button ();
22+
button.MakeShiny = true; // new API
23+
24+
The MakeShiny API works even if the button is already visible.
25+
26+
## Intended Use Case
27+
Provide a detailed example of where your proposal would be used and for what purpose.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: New API Spec
3+
about: An official specification for new APIS
4+
title: "[Spec] "
5+
labels: "feature-request"
6+
assignees: ''
7+
8+
---
9+
10+
# [The feature]
11+
12+
Provide a concise description of the feature and the motivation for adding it to Xamarin.Essentials
13+
14+
# API
15+
16+
## [ class ]
17+
18+
### Properties
19+
20+
| API | Description |
21+
| ------------- | ------------- |
22+
| [name] | Gets or sets [description]. |
23+
24+
### Events
25+
26+
| API | Description |
27+
| ------------- | ------------- |
28+
| [name] | [API documentation/description] |
29+
30+
# Scenarios
31+
32+
# Platform Compatibility
33+
- Target Frameworks: <!-- All that apply -->
34+
- iOS: <!-- Support on iOS for the API -->
35+
- Android: <!-- Support on Android for the API -->
36+
- UWP: <!-- Support on UWP for the API -->
37+
# Backward Compatibility
38+
39+
# Difficulty : [low/medium/high]

0 commit comments

Comments
 (0)