Skip to content

Commit 6a86f46

Browse files
HadenSmithHadenSmith
authored
Merge pull request #28 from USACE-RMC/oxyplot-improvements
Updating repo configurations
2 parents ca7410a + 1e9c9f2 commit 6a86f46

9 files changed

Lines changed: 282 additions & 75 deletions

File tree

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

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
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; use the instructions in SECURITY.md instead.
10+
11+
- type: textarea
12+
id: what-happened
13+
attributes:
14+
label: What happened?
15+
description: Briefly describe the problem.
16+
placeholder: Example: The program closes when I click Run Analysis.
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 you expected instead.
25+
placeholder: Example: I expected the analysis to finish and show the results table.
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 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 area or control
45+
description: Name the project, window, tool, or control if you know it.
46+
placeholder: Example: AvalonDock layout, DataTableView, OxyPlot control
47+
validations:
48+
required: false
49+
50+
- type: input
51+
id: framework-version
52+
attributes:
53+
label: WPF Framework version or commit
54+
description: Enter the version, package number, branch, or commit if you know it.
55+
placeholder: Example: v1.0.0 or commit abc1234
56+
validations:
57+
required: false
58+
59+
- type: input
60+
id: environment
61+
attributes:
62+
label: Windows, .NET, and Visual Studio details
63+
description: Add any version details you know.
64+
placeholder: Example: Windows 11, .NET 10 SDK, Visual Studio version if relevant
65+
validations:
66+
required: false
67+
68+
- type: dropdown
69+
id: theme
70+
attributes:
71+
label: Theme
72+
description: Choose the theme if the issue is visual.
73+
options:
74+
- Not sure or not visual
75+
- Light
76+
- Dark
77+
- Blue
78+
- Multiple themes
79+
validations:
80+
required: false
81+
82+
- type: upload
83+
id: files
84+
attributes:
85+
label: Screenshots, logs, or sample files
86+
description: Upload anything that helps explain the problem.
87+
validations:
88+
required: false
89+
accept: ".png,.jpg,.jpeg,.gif,.webp,.svg,.log,.txt,.csv,.json,.zip,.pdf,.docx,.xlsx"

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

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
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 or workflow problem.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: What problem would this solve?
15+
description: Describe the user need or workflow problem.
16+
placeholder: Example: I need to compare several scenarios without exporting each result manually.
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 or improvement.
25+
placeholder: Example: Add a button to export all scenario results to one Excel file.
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: workaround
43+
attributes:
44+
label: Current workaround
45+
description: How are you handling this now, if at all?
46+
placeholder: Example: I manually copy results from each scenario into Excel.
47+
validations:
48+
required: false
49+
50+
- type: input
51+
id: affected-area
52+
attributes:
53+
label: Affected area or control
54+
description: Name the project, window, tool, or control if you know it.
55+
placeholder: Example: Project explorer, theme system, NumericControls
56+
validations:
57+
required: false
58+
59+
- type: upload
60+
id: examples
61+
attributes:
62+
label: Examples, screenshots, or files
63+
description: Upload anything that helps explain the request.
64+
validations:
65+
required: false
66+
accept: ".png,.jpg,.jpeg,.gif,.webp,.svg,.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, help topic, or file if possible.
11+
placeholder: Example: User Guide, Section 3.2, Importing Data
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 guide says to select an output folder, but the current interface uses a file picker instead.
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: suggested-change
40+
attributes:
41+
label: Suggested change
42+
description: Optional. Suggest wording or content that would help.
43+
placeholder: Example: Add a screenshot showing the current import window.
44+
validations:
45+
required: false
46+
47+
- type: upload
48+
id: files
49+
attributes:
50+
label: Screenshots or files
51+
description: Upload screenshots or examples if helpful.
52+
validations:
53+
required: false
54+
accept: ".png,.jpg,.jpeg,.gif,.webp,.svg,.txt,.csv,.json,.zip,.pdf,.docx,.xlsx,.pptx"

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

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
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.
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 input file should I use for a frequency curve 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 a stage-frequency curve for a reservoir risk assessment.
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, settings, or examples you checked.
34+
placeholder: Example: I read the user guide and tried the sample dataset.
35+
validations:
36+
required: false
37+
38+
- type: input
39+
id: affected-area
40+
attributes:
41+
label: Affected area or control
42+
description: Name the project, window, tool, or control if you know it.
43+
placeholder: Example: Database controls, DAG demo, theme system
44+
validations:
45+
required: false
46+
47+
- type: upload
48+
id: files
49+
attributes:
50+
label: Screenshots or files
51+
description: Upload files or screenshots if they help explain the question.
52+
validations:
53+
required: false
54+
accept: ".png,.jpg,.jpeg,.gif,.webp,.svg,.log,.txt,.csv,.json,.zip,.pdf,.docx,.xlsx"

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 0 additions & 38 deletions
This file was deleted.

‎.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

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 0 additions & 27 deletions
This file was deleted.

‎.github/workflows/NuGetPublish.yml‎

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ on:
66

77
permissions:
88
contents: read
9+
id-token: write
910

1011
jobs:
1112
publish:
@@ -45,10 +46,16 @@ jobs:
4546
shell: pwsh
4647
run: .\scripts\pack-wpf-framework.ps1 -Configuration Release -Version $env:VERSION -OutputDirectory packages -SkipRestore -SkipBuild
4748

49+
- name: NuGet login
50+
uses: NuGet/login@v1
51+
id: login
52+
with:
53+
user: USACE-RMC
54+
4855
- name: Push to NuGet.org
4956
shell: pwsh
5057
env:
51-
NUGET_API_KEY: ${{ secrets.NUGET_ORG_API_KEY }}
58+
NUGET_API_KEY: ${{ steps.login.outputs.NUGET_API_KEY }}
5259
run: |
5360
$packageIds = @(
5461
"RMC.Wpf.Framework.Core",

‎CONTRIBUTING.md‎

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,21 +12,22 @@ If you plan to submit a pull request, please open an issue first to discuss your
1212

1313
### Report a Bug
1414

15-
If you find a bug, please [open an issue](../../issues/new) and include:
15+
If you find a bug, please [open a bug report](../../issues/new/choose) and include:
1616

17-
- Steps to reproduce the problem
18-
- Input data and configuration (if applicable)
19-
- Expected behavior vs. actual behavior
20-
- Software version and operating system
21-
- Any relevant error messages or screenshots
17+
- What happened and what you expected instead
18+
- Steps to reproduce the problem, if you know them
19+
- The affected area or control, if you know it
20+
- Software version and operating system details, if available
21+
- Any relevant error messages, screenshots, logs, or sample files
2222

2323
### Request a Feature
2424

25-
Feature requests are welcome. Please [open an issue](../../issues/new) describing:
25+
Feature requests are welcome. Please [open a feature request](../../issues/new/choose) describing:
2626

2727
- The use case or problem you are trying to solve
28-
- How you envision the feature working
29-
- Any references to similar implementations in other frameworks
28+
- What you would like the software or documentation to do
29+
- How important the request is to your work
30+
- Any current workaround, examples, screenshots, or files
3031

3132
### Submit a Pull Request
3233

0 commit comments

Comments
 (0)