diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml new file mode 100644 index 0000000..c18fd81 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -0,0 +1,84 @@ +name: Bug report +description: Report something that is not working correctly. +title: "[Bug]: " +labels: ["bug"] +body: + - type: markdown + attributes: + value: | + Thanks for reporting a problem. Please do not report security vulnerabilities here; contact the RMC team directly through official USACE-RMC channels. + + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Briefly describe the problem. + placeholder: "Example: Normal.InverseCDF returns NaN for a valid probability input." + validations: + required: true + + - type: textarea + id: expected-behavior + attributes: + label: What did you expect to happen? + description: Tell us what result or behavior you expected instead. + placeholder: "Example: I expected the method to return the same quantile value as R or SciPy." + validations: + required: true + + - type: textarea + id: steps-to-reproduce + attributes: + label: Steps to reproduce + description: List the steps, code, inputs, or data that caused the problem, if you know them. + value: | + 1. + 2. + 3. + validations: + required: false + + - type: input + id: affected-area + attributes: + label: Affected namespace, class, or method + description: Name the Numerics area if you know it. + placeholder: "Example: Numerics.Distributions.Normal, Statistics.ProductMoments, Integration.GaussLegendre" + validations: + required: false + + - type: input + id: numerics-version + attributes: + label: Numerics version, package version, branch, or commit + description: Enter the RMC.Numerics package version, branch, or commit if you know it. + placeholder: "Example: RMC.Numerics 2.1.1 or commit abc1234" + validations: + required: false + + - type: input + id: environment + attributes: + label: Operating system and .NET details + description: Add any OS, target framework, SDK, runtime, or IDE version details you know. + placeholder: "Example: Windows 11, net8.0, .NET 10 SDK, Visual Studio 2026" + validations: + required: false + + - type: input + id: input-data + attributes: + label: Input data or parameters + description: Include the key numeric values, distributions, sample sizes, seeds, or file formats involved. + placeholder: "Example: p = 0.999, mean = 0, standard deviation = 1" + validations: + required: false + + - type: upload + id: files + attributes: + label: Screenshots, logs, data, or sample files + description: Upload anything that helps reproduce or explain the problem. + validations: + required: false + accept: ".png,.jpg,.jpeg,.gif,.webp,.svg,.log,.txt,.csv,.json,.zip,.pdf,.docx,.xlsx,.pptx" diff --git a/.github/ISSUE_TEMPLATE/02-feature-request.yml b/.github/ISSUE_TEMPLATE/02-feature-request.yml new file mode 100644 index 0000000..33c0916 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/02-feature-request.yml @@ -0,0 +1,75 @@ +name: Feature request +description: Suggest a new feature or improvement. +title: "[Feature]: " +labels: ["enhancement"] +body: + - type: markdown + attributes: + value: | + Thanks for suggesting an improvement. Please focus on the user need, workflow, or numerical method you want to support. + + - type: textarea + id: problem + attributes: + label: What problem would this solve? + description: Describe the user need, workflow problem, or numerical/statistical gap. + placeholder: "Example: I need to fit a distribution using censored hydrologic data without implementing the estimator myself." + validations: + required: true + + - type: textarea + id: desired-behavior + attributes: + label: What would you like to happen? + description: Describe the feature, API, method, or improvement. + placeholder: "Example: Add parameter estimation support for left-censored samples in the LogPearsonIII distribution." + validations: + required: true + + - type: dropdown + id: importance + attributes: + label: How important is this to your work? + options: + - Nice to have + - Helpful + - Important + - Blocking my work + validations: + required: true + + - type: textarea + id: references + attributes: + label: References or validation sources + description: Add published methods, software references, tables, or example implementations if relevant. + placeholder: "Example: Bulletin 17C, an R package, SciPy documentation, or a peer-reviewed paper." + validations: + required: false + + - type: textarea + id: workaround + attributes: + label: Current workaround + description: How are you handling this now, if at all? + placeholder: "Example: I call an R package separately and import the results into my .NET workflow." + validations: + required: false + + - type: input + id: affected-area + attributes: + label: Affected namespace, class, or method + description: Name the Numerics area if you know it. + placeholder: "Example: Probability distributions, optimization, MCMC sampling, interpolation" + validations: + required: false + + - type: upload + id: examples + attributes: + label: Examples, screenshots, data, or files + description: Upload anything that helps explain the request. + validations: + required: false + accept: ".png,.jpg,.jpeg,.gif,.webp,.svg,.log,.txt,.csv,.json,.zip,.pdf,.docx,.xlsx,.pptx" diff --git a/.github/ISSUE_TEMPLATE/03-documentation.yml b/.github/ISSUE_TEMPLATE/03-documentation.yml new file mode 100644 index 0000000..df804ee --- /dev/null +++ b/.github/ISSUE_TEMPLATE/03-documentation.yml @@ -0,0 +1,54 @@ +name: Documentation +description: Report missing, unclear, or incorrect documentation. +title: "[Docs]: " +labels: ["documentation"] +body: + - type: textarea + id: location + attributes: + label: Where is the documentation issue? + description: Link to the page, section, API member, or file if possible. + placeholder: "Example: docs/distributions/univariate.md, XML docs for Normal.CDF, or the README installation section" + validations: + required: true + + - type: dropdown + id: issue-type + attributes: + label: What type of documentation issue is this? + options: + - Missing information + - Unclear explanation + - Incorrect information + - Typo or formatting problem + - Example needed + - Other + validations: + required: true + + - type: textarea + id: description + attributes: + label: Describe the issue + description: What is confusing, missing, or incorrect? + placeholder: "Example: The documentation describes the parameter as scale, but the API uses rate." + validations: + required: true + + - type: textarea + id: suggested-change + attributes: + label: Suggested change + description: Optional. Suggest wording, examples, equations, or references that would help. + placeholder: "Example: Add a C# example showing how to fit a distribution and evaluate its CDF." + validations: + required: false + + - type: upload + id: files + attributes: + label: Screenshots, references, or files + description: Upload screenshots, source references, example data, or other supporting files if helpful. + validations: + required: false + accept: ".png,.jpg,.jpeg,.gif,.webp,.svg,.log,.txt,.csv,.json,.zip,.pdf,.docx,.xlsx,.pptx" diff --git a/.github/ISSUE_TEMPLATE/04-question.yml b/.github/ISSUE_TEMPLATE/04-question.yml new file mode 100644 index 0000000..892de71 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/04-question.yml @@ -0,0 +1,63 @@ +name: Question +description: Ask a specific question about using the project. +title: "[Question]: " +labels: ["question"] +body: + - type: markdown + attributes: + value: | + Please use this form for specific usage questions about RMC.Numerics. + + - type: textarea + id: question + attributes: + label: What is your question? + description: Ask the question as clearly as possible. + placeholder: "Example: Which distribution class should I use for a flood frequency analysis with historical information?" + validations: + required: true + + - type: textarea + id: goal + attributes: + label: What are you trying to do? + description: Briefly describe your workflow or goal. + placeholder: "Example: I am trying to estimate uncertainty bounds for a stage-frequency curve in a .NET application." + validations: + required: false + + - type: textarea + id: tried + attributes: + label: What have you already tried? + description: Optional. Tell us what documentation, methods, examples, or tests you checked. + placeholder: "Example: I read the user guide and looked at the MCMC sampling tests." + validations: + required: false + + - type: input + id: affected-area + attributes: + label: Affected namespace, class, or method + description: Name the Numerics area if you know it. + placeholder: "Example: Distributions, statistics, optimization, random sampling" + validations: + required: false + + - type: input + id: environment + attributes: + label: Operating system and .NET details + description: Add any OS, target framework, SDK, runtime, or IDE version details that may matter. + placeholder: "Example: Windows 11, net8.0, .NET 10 SDK, Rider or Visual Studio" + validations: + required: false + + - type: upload + id: files + attributes: + label: Screenshots, logs, data, or files + description: Upload files or screenshots if they help explain the question. + validations: + required: false + accept: ".png,.jpg,.jpeg,.gif,.webp,.svg,.log,.txt,.csv,.json,.zip,.pdf,.docx,.xlsx,.pptx" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..3ba13e0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: false