Skip to content

Commit d35d1f5

Browse files
danielcweberdanielcweber
authored
Merge pull request #1102 from akarnokd/GithubTemplates
Add Github welcome issue/PR templates
2 parents 2aba792 + ec3c95c commit d35d1f5

File tree

4 files changed

+272
-0
lines changed

4 files changed

+272
-0
lines changed

‎.github/ISSUE_TEMPLATE/issue_ix.md‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
---
2+
name: Issue report for Ix
3+
about: Creates an issue report regarding a bug, question or feature request for Ix.NET
4+
title: ''
5+
labels: '[area] Ix'
6+
assignees: ''
7+
---
8+
Hello and thank you for using dotnet/reactive. Please select a category and detail your issue by answering the questions there:
9+
10+
#### Bug
11+
12+
Despite our best efforts, bugs can slip into releases or corner cases forgotten about. We will try our best to remedy the situation
13+
and/or provide workarounds. Note that certain (odd) behaviors are by design and as such are not considered bugs.
14+
15+
> Which subcomponent library (Ix, Async.Ix)?
16+
17+
> Which library version?
18+
19+
> What are the platform(s), environment(s) and related component version(s)?
20+
21+
> What is the use case or problem?
22+
23+
> What is the expected outcome?
24+
25+
> What is the actual outcome?
26+
27+
> What is the stacktrace of the exception(s) if any?
28+
29+
> Do you have a code snippet or project that reproduces the problem?
30+
31+
#### Question
32+
33+
Before you ask us a question, please note that dotnet/reactive is maintained by a handful of dedicated people voluntarily and in their free time.
34+
You could help us tremendously by first searching for some keywords related to your question with your favorite search engine,
35+
our [issue list](https://github.com/dotnet/reactive/issues) or the related [stackoverflow.com](https://stackoverflow.com) keywords (such as
36+
[ienumerable](https://stackoverflow.com/questions/tagged/ienumerable) and
37+
[iasyncenumerable](https://stackoverflow.com/questions/tagged/iasyncenumerable)
38+
). Please also consider asking questions, such as **"How do I do X?"** or **"Where can I find Y?"**, under one of these tags on *StackOverflow* instead.
39+
40+
In case you have not found an answer or your question is not really suited for *StackOverflow*, you are welcome to ask it here.
41+
42+
> What is the context of your question or problem?
43+
44+
> What is the question or problem you try to solve?
45+
46+
> What were the (original) requirements you tried to solve?
47+
48+
> What have you tried so far, what code have you written so far?
49+
50+
#### Feature request
51+
52+
The dotnet/reactive hosts fundamental components and operators for `IObservable`, `IEnumerable` and `IAsyncEnumerable`, and as such, to be and
53+
to stay as a dependable family of libraries, we have to carefully consider what new features to include. Therefore, before asking for a new component,
54+
operator or feature, please consider the following cases and resolutions first:
55+
56+
a) **New source factory method.** Static factory methods creating an instance of the types mentioned above can live in any class in any library
57+
without too much inconvenience. Please consider hosting such factory methods outside dotnet/reactive.
58+
59+
b) **New instance method/operator.** The .NET world features extension methods which gives the flexibility to have fluent API expansions in
60+
your local project or any third party library. Please consider hosting such methods outside dotnet/reactive too.
61+
62+
c) **Support for or bridge to other 1st or 3rd party components.** These are considered on a specific case-by-case basis but generally,
63+
please consider hosting such support/bridge code outside dotnet/reactive.
64+
65+
d) **New reactive/interactive base type or concept.** Components requiring changes or introduction of new protocols (for example, flow control,
66+
item lifecycle, async) are generally better suited for their own 3rd party library hosting and interoperation should be provided, via the standard
67+
types mentioned above, there.
68+
69+
e) **Behavior change on an existing operator.** Such changes involve a lot of risks for existing users, therefore, usually, it is better to introduce
70+
a completely new component or operator, for which see points a)..d) again.
71+
72+
Considering the points above, please describe the feature or behavior you would like dotnet/reactive included:
73+
74+
> Which subcomponent library (Ix, Async.Ix)?
75+
76+
> Which next library version (i.e., patch, minor or major)?
77+
78+
> What are the platform(s), environment(s) and related component version(s)?
79+
80+
> How commonly is this feature needed (one project, several projects, company-wide, global)?
81+
82+
> Please describe the feature.

‎.github/ISSUE_TEMPLATE/issue_rx.md‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
---
2+
name: Issue report for Rx
3+
about: Creates an issue report regarding a bug, question or feature request for Rx.NET
4+
title: ''
5+
labels: '[area] Rx'
6+
assignees: ''
7+
---
8+
Hello and thank you for using dotnet/reactive. Please select a category and detail your issue by answering the questions there:
9+
10+
#### Bug
11+
12+
Despite our best efforts, bugs can slip into releases or corner cases forgotten about. We will try our best to remedy the situation
13+
and/or provide workarounds. Note that certain (odd) behaviors are by design and as such are not considered bugs.
14+
15+
> Which library version?
16+
17+
> What are the platform(s), environment(s) and related component version(s)?
18+
19+
> What is the use case or problem?
20+
21+
> What is the expected outcome?
22+
23+
> What is the actual outcome?
24+
25+
> What is the stacktrace of the exception(s) if any?
26+
27+
> Do you have a code snippet or project that reproduces the problem?
28+
29+
#### Question
30+
31+
Before you ask us a question, please note that dotnet/reactive is maintained by a handful of dedicated people voluntarily and in their free time.
32+
You could help us tremendously by first searching for some keywords related to your question with your favorite search engine,
33+
our [issue list](https://github.com/dotnet/reactive/issues) or the related [stackoverflow.com](https://stackoverflow.com) keywords (such as
34+
[system.reactive](https://stackoverflow.com/questions/tagged/system.reactive)
35+
). Please also consider asking questions, such as **"How do I do X?"** or **"Where can I find Y?"**, under one of these tags on *StackOverflow* instead.
36+
37+
In case you have not found an answer or your question is not really suited for *StackOverflow*, you are welcome to ask it here.
38+
39+
> What is the context of your question or problem?
40+
41+
> What is the question or problem you try to solve?
42+
43+
> What were the (original) requirements you tried to solve?
44+
45+
> What have you tried so far, what code have you written so far?
46+
47+
#### Feature request
48+
49+
The dotnet/reactive hosts fundamental components and operators for `IObservable`, `IEnumerable` and `IAsyncEnumerable`, and as such, to be and
50+
to stay as a dependable family of libraries, we have to carefully consider what new features to include. Therefore, before asking for a new component,
51+
operator or feature, please consider the following cases and resolutions first:
52+
53+
a) **New source factory method.** Static factory methods creating an instance of the types mentioned above can live in any class in any library
54+
without too much inconvenience. Please consider hosting such factory methods outside dotnet/reactive.
55+
56+
b) **New instance method/operator.** The .NET world features extension methods which gives the flexibility to have fluent API expansions in
57+
your local project or any third party library. Please consider hosting such methods outside dotnet/reactive too.
58+
59+
c) **Support for or bridge to other 1st or 3rd party components.** These are considered on a specific case-by-case basis but generally,
60+
please consider hosting such support/bridge code outside dotnet/reactive.
61+
62+
d) **New reactive/interactive base type or concept.** Components requiring changes or introduction of new protocols (for example, flow control,
63+
item lifecycle, async) are generally better suited for their own 3rd party library hosting and interoperation should be provided, via the standard
64+
types mentioned above, there.
65+
66+
e) **Behavior change on an existing operator.** Such changes involve a lot of risks for existing users, therefore, usually, it is better to introduce
67+
a completely new component or operator, for which see points a)..d) again.
68+
69+
Considering the points above, please describe the feature or behavior you would like dotnet/reactive included:
70+
71+
> Which next library version (i.e., patch, minor or major)?
72+
73+
> What are the platform(s), environment(s) and related component version(s)?
74+
75+
> How commonly is this feature needed (one project, several projects, company-wide, global)?
76+
77+
> Please describe the feature.

‎.github/PULL_REQUEST_TEMPLATE/pr_ix.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: Pull request for Ix
3+
about: Creates a Pull request regarding a bug, enhancement or feature request for Ix.NET
4+
title: ''
5+
labels: '[area] Ix'
6+
assignees: ''
7+
---Hello and thank you for contributing to dotnet/reactive. Before you proceed by creating a pull request (PR):
8+
9+
> Please make sure your contribution is in line with the project's [licensing model](https://github.com/dotnet/reactive/blob/master/LICENSE) and
10+
your employment allows you to contribute to open source.
11+
12+
> Please sign the [Contributor License Agreement](https://cla.dotnetfoundation.org/dotnet/reactive?pullRequest=1101) in case the CLA bot asks you
13+
for being a new contributor.
14+
15+
> Please make sure you target the `master` branch when creating the PR.
16+
17+
What is the nature of your contribution?
18+
19+
#### Bugfix
20+
21+
> Please describe what and how the bug manifested itself and what kind of fix did you implement.
22+
> Practically, you are writing these descriptions for the search engines so others can find the resolution easier.
23+
24+
> Please reference the related issue(s) to the original bug report (example: `Fixes #X`, `Resolves #X`).
25+
> Note that some behaviors are by design and are not bugs. If you are unsure, please open an [issue](https://github.com/dotnet/reactive/issues) first.
26+
27+
> Please include the relevant unit test(s) that verify the fix works.
28+
> It is recommended you write the unit test(s) first to see they failed before your fix; however, there is
29+
> no need to post a PR to demonstrate this failure stage. Please post in a state where the issue is resolved.
30+
31+
#### Enhancement
32+
33+
> Please consider opening an [issue](https://github.com/dotnet/reactive/issues) first to discuss the kind and impact of the enhancement first,
34+
> if such issue doesn't exist yet. Also please check if there was a consensus about accepting such an enhancement.
35+
36+
> Please describe how, what and why the enhancement is implemented.
37+
> Practically, you are writing these descriptions for the search engines so others can find the change details easier.
38+
39+
> Please reference the related issue(s) to the original issue report (example: `Fixes #X`, `Resolves #X`).
40+
41+
> Please include the relevant unit test(s) or benchmark(s) that show or verify the enhancement works.
42+
43+
#### Feature request
44+
45+
> We strongly recommend opening an [issue](https://github.com/dotnet/reactive/issues) first to discuss the nature and impact of the request first.
46+
> If such an issue already exists, please check if there was a consensus and approval for accepting a contribution.
47+
48+
> Please describe what request is about, how it works in general and what possible corner cases it or the user should consider.
49+
> Please include some basic usage examples of the important components and/or overloads.
50+
> Practically, you are writing these descriptions for the search engines so others can find out about the new feature easier.
51+
52+
> Please reference the related issue(s) to the original issue report (example: `Resolves #X`).
53+
54+
> Please include unit tests that verify the behavior of the new feature. Please make sure the code coverage is reasonably high with the new code.
55+
> Depending on the feature, you may want to include actual multi-threaded test cases to verify the correct async behavior, however,
56+
> please be mindful of the time such tests take and try to stay under a few seconds.

‎.github/PULL_REQUEST_TEMPLATE/pr_rx.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
name: Pull request for Rx
3+
about: Creates a Pull request regarding a bug, enhancement or feature request for Rx.NET
4+
title: ''
5+
labels: '[area] Rx'
6+
assignees: ''
7+
---
8+
Hello and thank you for contributing to dotnet/reactive. Before you proceed by creating a pull request (PR):
9+
10+
> Please make sure your contribution is in line with the project's [licensing model](https://github.com/dotnet/reactive/blob/master/LICENSE) and
11+
your employment allows you to contribute to open source.
12+
13+
> Please sign the [Contributor License Agreement](https://cla.dotnetfoundation.org/dotnet/reactive?pullRequest=1101) in case the CLA bot asks you
14+
for being a new contributor.
15+
16+
> Please make sure you target the `master` branch when creating the PR.
17+
18+
What is the nature of your contribution?
19+
20+
#### Bugfix
21+
22+
> Please describe what and how the bug manifested itself and what kind of fix did you implement.
23+
> Practically, you are writing these descriptions for the search engines so others can find the resolution easier.
24+
25+
> Please reference the related issue(s) to the original bug report (example: `Fixes #X`, `Resolves #X`).
26+
> Note that some behaviors are by design and are not bugs. If you are unsure, please open an [issue](https://github.com/dotnet/reactive/issues) first.
27+
28+
> Please include the relevant unit test(s) that verify the fix works.
29+
> It is recommended you write the unit test(s) first to see they failed before your fix; however, there is
30+
> no need to post a PR to demonstrate this failure stage. Please post in a state where the issue is resolved.
31+
32+
#### Enhancement
33+
34+
> Please consider opening an [issue](https://github.com/dotnet/reactive/issues) first to discuss the kind and impact of the enhancement first,
35+
> if such an issue doesn't exist yet. Also please check if there was a consensus about accepting such an enhancement.
36+
37+
> Please describe how, what and why the enhancement is implemented.
38+
> Practically, you are writing these descriptions for the search engines so others can find the change details easier.
39+
40+
> Please reference the related issue(s) to the original issue report (example: `Fixes #X`, `Resolves #X`).
41+
42+
> Please include the relevant unit test(s) or benchmark(s) that show or verify the enhancement works.
43+
44+
#### Feature request
45+
46+
> We strongly recommend opening an [issue](https://github.com/dotnet/reactive/issues) first to discuss the nature and impact of the request first.
47+
> If such an issue already exists, please check if there was a consensus and approval for accepting a contribution.
48+
49+
> Please describe what request is about, how it works in general and what possible corner cases it or the user should consider.
50+
> Please include some basic usage examples of the important components and/or overloads.
51+
> Practically, you are writing these descriptions for the search engines so others can find out about the new feature easier.
52+
53+
> Please reference the related issue(s) to the original issue report (example: `Resolves #X`).
54+
55+
> Please include unit tests that verify the behavior of the new feature. Please make sure the code coverage is reasonably high with the new code.
56+
> Depending on the feature, you may want to include actual multi-threaded test cases to verify the correct async behavior, however,
57+
> please be mindful of the time such tests take and try to stay under a few seconds.

0 commit comments

Comments
 (0)