You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Note: the following is not mandatory, just a guideline. Feel free to describe your bug report or suggestion in another way.
9
+
- type: textarea
10
+
id: background
11
+
attributes:
12
+
label: Description
13
+
description: Please provide a succinct description of your issue.
14
+
placeholder: Description
15
+
validations:
16
+
required: true
17
+
- type: textarea
18
+
id: known-workarounds
19
+
attributes:
20
+
label: Known Workarounds
21
+
description: Please provide a description of any known workarounds.
22
+
placeholder: Known Workarounds
23
+
validations:
24
+
required: false
25
+
- type: textarea
26
+
id: expected-behavior
27
+
attributes:
28
+
label: Expected behavior
29
+
description: Provide a description of the expected behavior.
30
+
placeholder: Expected behavior
31
+
validations:
32
+
required: false
33
+
- type: textarea
34
+
id: actual-behavior
35
+
attributes:
36
+
label: Actual behavior
37
+
description: |
38
+
Provide a description of the actual behavior observed. If applicable please include any error messages or exception stack-traces.
39
+
placeholder: Actual behavior
40
+
validations:
41
+
required: false
42
+
- type: textarea
43
+
id: configuration
44
+
attributes:
45
+
label: Configuration
46
+
description: |
47
+
Please provide more information on your .NET configuration:
48
+
* Operating system
49
+
* Branch/Version
50
+
* .NET Runtime, CoreCLR or Mono Version
51
+
* Performance information, links to performance testing scripts
52
+
placeholder: Configuration
53
+
validations:
54
+
required: false
55
+
- type: textarea
56
+
id: repro-steps
57
+
attributes:
58
+
label: Reproduction Steps
59
+
description: |
60
+
Please include minimal steps to reproduce the problem if possible. E.g.: the smallest possible code snippet; or a small project, with steps to run it.
61
+
Always include text as text rather than screenshots so code can easily be copied and will show up in searches.
62
+
Stack Overflow has a great article about [how to create a minimal, reproducible example](https://stackoverflow.com/help/minimal-reproducible-example).
63
+
placeholder: Minimal Reproduction
64
+
validations:
65
+
required: false
66
+
- type: dropdown
67
+
id: pull-request
68
+
attributes:
69
+
label: Are you willing to help with a pull-request?
70
+
description: |
71
+
Make sure you have read the sections about [contributing changes](https://github.com/fsprojects/FSharpPlus/blob/master/DEVELOPER_GUIDE.md) and [design guidelines](https://github.com/fsprojects/FSharpPlus/blob/master/DESIGN_GUIDELINES.md).
description: Propose a change to the public API surface
3
+
title: "[API Proposal]: "
4
+
labels: [api-suggestion]
5
+
body:
6
+
- type: markdown
7
+
attributes:
8
+
value: |
9
+
We welcome API proposals! We have a process to evaluate the value and shape of new API. This template will help us gather the information we need to start the review process.
10
+
- type: textarea
11
+
id: background
12
+
attributes:
13
+
label: Background and motivation
14
+
description: Please describe the purpose and value of the new API here.
15
+
placeholder: Purpose
16
+
validations:
17
+
required: true
18
+
- type: textarea
19
+
id: api-proposal
20
+
attributes:
21
+
label: API Proposal
22
+
description: |
23
+
Please provide the specific public API signature diff that you are proposing.
24
+
placeholder: API declaration (no function bodies)
25
+
validations:
26
+
required: true
27
+
- type: textarea
28
+
id: api-usage
29
+
attributes:
30
+
label: API Usage
31
+
description: |
32
+
Please provide code examples that highlight how the proposed API additions are meant to be consumed. This will help suggest whether the API has the right shape to be functional, performant and usable.
33
+
placeholder: API usage
34
+
validations:
35
+
required: true
36
+
- type: textarea
37
+
id: alternative-designs
38
+
attributes:
39
+
label: Alternative Designs
40
+
description: |
41
+
Please provide alternative designs. This might not be APIs; for example instead of providing new APIs an option might be to change the behavior of an existing API.
42
+
placeholder: Alternative designs
43
+
validations:
44
+
required: false
45
+
- type: textarea
46
+
id: risks
47
+
attributes:
48
+
label: Risks
49
+
description: |
50
+
Please mention any risks that to your knowledge the API proposal might entail, such as breaking changes, performance regressions, etc.
51
+
placeholder: Risks
52
+
validations:
53
+
required: false
54
+
- type: dropdown
55
+
id: pull-request
56
+
attributes:
57
+
label: Are you willing to help with a proof-of-concept (as PR in that or a separate repo) first and as pull-request later on?
58
+
description: |
59
+
This is mainly to help demonstrate your suggestion.
60
+
Make sure you have read the sections about [contributing changes](https://github.com/fsprojects/FSharpPlus/blob/master/DEVELOPER_GUIDE.md) and [design guidelines](https://github.com/fsprojects/FSharpPlus/blob/master/DESIGN_GUIDELINES.md).
61
+
Beware we might not accept the PR as is, but it will help us understand your suggestion better.
name: 💡 General feature (not including API proposals)
2
+
description: Discuss a new feature that does not change the public API surface
3
+
title: "[Feature]: "
4
+
labels: [feature, triage]
5
+
body:
6
+
- type: markdown
7
+
attributes:
8
+
value: |
9
+
You have an idea for a new feature? Cool, let's discuss it.
10
+
- type: textarea
11
+
id: background
12
+
attributes:
13
+
label: Background and motivation
14
+
description: Please describe the purpose of the new feature.
15
+
placeholder: Purpose
16
+
validations:
17
+
required: true
18
+
- type: textarea
19
+
id: alternative-concerns
20
+
attributes:
21
+
label: Alternative Concerns
22
+
description: |
23
+
Please provide alternatives you have thought about.
24
+
placeholder: Alternative designs
25
+
validations:
26
+
required: false
27
+
- type: dropdown
28
+
id: pull-request
29
+
attributes:
30
+
label: Are you willing help with a pull-request?
31
+
description: |
32
+
Make sure you have read the sections about [contributing changes](https://github.com/fsprojects/FSharpPlus/blob/master/DEVELOPER_GUIDE.md) and [design guidelines](https://github.com/fsprojects/FSharpPlus/blob/master/DESIGN_GUIDELINES.md).
33
+
Beware we might not accept the PR as is, but it will help us understand your suggestion better.
0 commit comments