Skip to content

Commit 1b6aa52

Browse files
HadenSmithHadenSmith
authored
Merge pull request #141 from USACE-RMC/bug-fixes-and-enhancements
Add Numerics issue templates
2 parents a2c4dbf + 0436d46 commit 1b6aa52

5 files changed

Lines changed: 277 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/01-bug-report.yml‎

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,84 @@
1+
name: Bug report
2+
description: Report something that is not working correctly.
3+
title: "[Bug]: "
4+
labels: ["bug"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for reporting a problem. Please do not report security vulnerabilities here; contact the RMC team directly through official USACE-RMC channels.
10+
11+
- type: textarea
12+
id: what-happened
13+
attributes:
14+
label: What happened?
15+
description: Briefly describe the problem.
16+
placeholder: "Example: Normal.InverseCDF returns NaN for a valid probability input."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: expected-behavior
22+
attributes:
23+
label: What did you expect to happen?
24+
description: Tell us what result or behavior you expected instead.
25+
placeholder: "Example: I expected the method to return the same quantile value as R or SciPy."
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: steps-to-reproduce
31+
attributes:
32+
label: Steps to reproduce
33+
description: List the steps, code, inputs, or data that caused the problem, if you know them.
34+
value: |
35+
1.
36+
2.
37+
3.
38+
validations:
39+
required: false
40+
41+
- type: input
42+
id: affected-area
43+
attributes:
44+
label: Affected namespace, class, or method
45+
description: Name the Numerics area if you know it.
46+
placeholder: "Example: Numerics.Distributions.Normal, Statistics.ProductMoments, Integration.GaussLegendre"
47+
validations:
48+
required: false
49+
50+
- type: input
51+
id: numerics-version
52+
attributes:
53+
label: Numerics version, package version, branch, or commit
54+
description: Enter the RMC.Numerics package version, branch, or commit if you know it.
55+
placeholder: "Example: RMC.Numerics 2.1.1 or commit abc1234"
56+
validations:
57+
required: false
58+
59+
- type: input
60+
id: environment
61+
attributes:
62+
label: Operating system and .NET details
63+
description: Add any OS, target framework, SDK, runtime, or IDE version details you know.
64+
placeholder: "Example: Windows 11, net8.0, .NET 10 SDK, Visual Studio 2026"
65+
validations:
66+
required: false
67+
68+
- type: input
69+
id: input-data
70+
attributes:
71+
label: Input data or parameters
72+
description: Include the key numeric values, distributions, sample sizes, seeds, or file formats involved.
73+
placeholder: "Example: p = 0.999, mean = 0, standard deviation = 1"
74+
validations:
75+
required: false
76+
77+
- type: upload
78+
id: files
79+
attributes:
80+
label: Screenshots, logs, data, or sample files
81+
description: Upload anything that helps reproduce or explain the problem.
82+
validations:
83+
required: false
84+
accept: ".png,.jpg,.jpeg,.gif,.webp,.svg,.log,.txt,.csv,.json,.zip,.pdf,.docx,.xlsx,.pptx"

‎.github/ISSUE_TEMPLATE/02-feature-request.yml‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
name: Feature request
2+
description: Suggest a new feature or improvement.
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting an improvement. Please focus on the user need, workflow, or numerical method you want to support.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: What problem would this solve?
15+
description: Describe the user need, workflow problem, or numerical/statistical gap.
16+
placeholder: "Example: I need to fit a distribution using censored hydrologic data without implementing the estimator myself."
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: desired-behavior
22+
attributes:
23+
label: What would you like to happen?
24+
description: Describe the feature, API, method, or improvement.
25+
placeholder: "Example: Add parameter estimation support for left-censored samples in the LogPearsonIII distribution."
26+
validations:
27+
required: true
28+
29+
- type: dropdown
30+
id: importance
31+
attributes:
32+
label: How important is this to your work?
33+
options:
34+
- Nice to have
35+
- Helpful
36+
- Important
37+
- Blocking my work
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: references
43+
attributes:
44+
label: References or validation sources
45+
description: Add published methods, software references, tables, or example implementations if relevant.
46+
placeholder: "Example: Bulletin 17C, an R package, SciPy documentation, or a peer-reviewed paper."
47+
validations:
48+
required: false
49+
50+
- type: textarea
51+
id: workaround
52+
attributes:
53+
label: Current workaround
54+
description: How are you handling this now, if at all?
55+
placeholder: "Example: I call an R package separately and import the results into my .NET workflow."
56+
validations:
57+
required: false
58+
59+
- type: input
60+
id: affected-area
61+
attributes:
62+
label: Affected namespace, class, or method
63+
description: Name the Numerics area if you know it.
64+
placeholder: "Example: Probability distributions, optimization, MCMC sampling, interpolation"
65+
validations:
66+
required: false
67+
68+
- type: upload
69+
id: examples
70+
attributes:
71+
label: Examples, screenshots, data, or files
72+
description: Upload anything that helps explain the request.
73+
validations:
74+
required: false
75+
accept: ".png,.jpg,.jpeg,.gif,.webp,.svg,.log,.txt,.csv,.json,.zip,.pdf,.docx,.xlsx,.pptx"

‎.github/ISSUE_TEMPLATE/03-documentation.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
name: Documentation
2+
description: Report missing, unclear, or incorrect documentation.
3+
title: "[Docs]: "
4+
labels: ["documentation"]
5+
body:
6+
- type: textarea
7+
id: location
8+
attributes:
9+
label: Where is the documentation issue?
10+
description: Link to the page, section, API member, or file if possible.
11+
placeholder: "Example: docs/distributions/univariate.md, XML docs for Normal.CDF, or the README installation section"
12+
validations:
13+
required: true
14+
15+
- type: dropdown
16+
id: issue-type
17+
attributes:
18+
label: What type of documentation issue is this?
19+
options:
20+
- Missing information
21+
- Unclear explanation
22+
- Incorrect information
23+
- Typo or formatting problem
24+
- Example needed
25+
- Other
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: description
31+
attributes:
32+
label: Describe the issue
33+
description: What is confusing, missing, or incorrect?
34+
placeholder: "Example: The documentation describes the parameter as scale, but the API uses rate."
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: suggested-change
40+
attributes:
41+
label: Suggested change
42+
description: Optional. Suggest wording, examples, equations, or references that would help.
43+
placeholder: "Example: Add a C# example showing how to fit a distribution and evaluate its CDF."
44+
validations:
45+
required: false
46+
47+
- type: upload
48+
id: files
49+
attributes:
50+
label: Screenshots, references, or files
51+
description: Upload screenshots, source references, example data, or other supporting files if helpful.
52+
validations:
53+
required: false
54+
accept: ".png,.jpg,.jpeg,.gif,.webp,.svg,.log,.txt,.csv,.json,.zip,.pdf,.docx,.xlsx,.pptx"

‎.github/ISSUE_TEMPLATE/04-question.yml‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
name: Question
2+
description: Ask a specific question about using the project.
3+
title: "[Question]: "
4+
labels: ["question"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Please use this form for specific usage questions about RMC.Numerics.
10+
11+
- type: textarea
12+
id: question
13+
attributes:
14+
label: What is your question?
15+
description: Ask the question as clearly as possible.
16+
placeholder: "Example: Which distribution class should I use for a flood frequency analysis with historical information?"
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: goal
22+
attributes:
23+
label: What are you trying to do?
24+
description: Briefly describe your workflow or goal.
25+
placeholder: "Example: I am trying to estimate uncertainty bounds for a stage-frequency curve in a .NET application."
26+
validations:
27+
required: false
28+
29+
- type: textarea
30+
id: tried
31+
attributes:
32+
label: What have you already tried?
33+
description: Optional. Tell us what documentation, methods, examples, or tests you checked.
34+
placeholder: "Example: I read the user guide and looked at the MCMC sampling tests."
35+
validations:
36+
required: false
37+
38+
- type: input
39+
id: affected-area
40+
attributes:
41+
label: Affected namespace, class, or method
42+
description: Name the Numerics area if you know it.
43+
placeholder: "Example: Distributions, statistics, optimization, random sampling"
44+
validations:
45+
required: false
46+
47+
- type: input
48+
id: environment
49+
attributes:
50+
label: Operating system and .NET details
51+
description: Add any OS, target framework, SDK, runtime, or IDE version details that may matter.
52+
placeholder: "Example: Windows 11, net8.0, .NET 10 SDK, Rider or Visual Studio"
53+
validations:
54+
required: false
55+
56+
- type: upload
57+
id: files
58+
attributes:
59+
label: Screenshots, logs, data, or files
60+
description: Upload files or screenshots if they help explain the question.
61+
validations:
62+
required: false
63+
accept: ".png,.jpg,.jpeg,.gif,.webp,.svg,.log,.txt,.csv,.json,.zip,.pdf,.docx,.xlsx,.pptx"

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false

0 commit comments

Comments
 (0)