Skip to content

Commit 3269a4e

Browse files
imikejacksonimikejackson
authored
CI: Add Azure CI configuration files (#9)
CI: Add GitHub CI configuration files
1 parent 6d4cca7 commit 3269a4e

File tree

13 files changed

+868
-1
lines changed

13 files changed

+868
-1
lines changed

‎.clang-format‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,8 @@ SpaceBeforeParens: Never
8282
# SpacesInCStyleCastParentheses: false
8383
# SpacesInParentheses: false
8484
# SpacesInSquareBrackets: false
85-
Standard: Cpp11
85+
SpaceAfterTemplateKeyword: true
86+
Standard: c++20
8687
TabWidth: 2
8788
UseTab: Never
8889
...

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
name: Bug Report
2+
description: File a bug report
3+
title: "BUG: "
4+
labels: ["bug", "needs triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
We're sorry to hear your having trouble with our application. By filling out the following form in its entirety, we will be able to better diagnose the problem and help you reach a resolution. Thank you in advance for taking the time to fill out the form!
10+
- type: checkboxes
11+
attributes:
12+
label: Is there an existing issue for this?
13+
description: Please search to see if an issue already exists for the bug you encountered.
14+
options:
15+
- label: I have searched the existing issues, known issues in release notes, and documentation.
16+
required: true
17+
- type: textarea
18+
id: brief-description
19+
attributes:
20+
label: Brief Description of the Issue and Expected Behavior
21+
description: Briefly describe the issue you encountered and what you expected to happen.
22+
placeholder: Tell us what you see!
23+
value: "A bug happened!"
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: system-information
28+
attributes:
29+
label: Platform and Version Information
30+
description: |
31+
Please complete the following steps and paste it in the box below:
32+
33+
1. Select the `Help` dropdown from the taskbar at the top left side of the application
34+
2. Select the `About DREAM3D-NX` option near the bottom of the dropdown submenu
35+
3. Click the `Copy Info` button from the pop-up window to copy it to your clipboard
36+
4. Paste the information in the box below, using `ctrl-v` on the keyboard or by left-clicking and selecting `paste`
37+
38+
Example copied information shown in the preview.
39+
placeholder: |
40+
DREAM3D-NX Build Revision: cba61ebbca
41+
DREAM3D-NX Build Date: 2025/07/18
42+
Operating System: Ubuntu 22.04.5 LTS
43+
Architecture: x86_64
44+
System Locale: en_US
45+
Installed RAM: 62.5 GB
46+
Built and maintained by BlueQuartz Software, LLC.
47+
validations:
48+
required: true
49+
- type: dropdown
50+
id: error-type
51+
attributes:
52+
label: What section did you encounter the error in? [Further details may be required during triage process]
53+
multiple: true
54+
options:
55+
- GUI client
56+
- NXRunner
57+
- Visualization
58+
- Workflow
59+
- Filter Library (or Search Bar)
60+
- Filter Parameters
61+
validations:
62+
required: false
63+
- type: textarea
64+
id: steps-to-reproduce
65+
attributes:
66+
label: Steps To Reproduce
67+
description: Please include the steps to reproduce the behavior in order to help you as efficiently as possible.
68+
placeholder: |
69+
1. With this config...
70+
2. Run '...'
71+
3. See error...
72+
validations:
73+
required: false
74+
- type: textarea
75+
id: logs
76+
attributes:
77+
label: Relevant log output
78+
description: Please copy and paste any relevant log output. This can be found in the output widget of the interface or the console output of PipelineRunner.
79+
render: "Text"
80+
validations:
81+
required: false
82+
- type: textarea
83+
id: further-detail
84+
attributes:
85+
label: Anything else?
86+
description: |
87+
Links? Pipelines? References? Compiler? Hardware? Anything that will give us more context about the issue you are encountering!
88+
89+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
90+
validations:
91+
required: false
92+
- type: checkboxes
93+
id: terms
94+
attributes:
95+
label: Code of Conduct
96+
description: By submitting this issue, you understand that your issue may be closed if you do not remain cordial, do not provide further detail if prompted, or do not engage with responses from the developers in a reasonable time.
97+
options:
98+
- label: I agree to follow this project's Code of Conduct
99+
required: true

‎.github/ISSUE_TEMPLATE/documentation_report.yml‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
name: Documentation Report
2+
description: File a report for additional sections or discrepancies, missing, or comment errors in our documentation.
3+
title: "DOC: "
4+
labels: ["documentation", "needs triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thank you for helping to better our documentation! By filling out the following form in its entirety, we will be able to better what needs to be fixed or improved on. Thank you in advance for taking the time to fill out the form!
10+
- type: checkboxes
11+
attributes:
12+
label: Is there an existing issue for this?
13+
description: Please search to see if an issue already exists for the bug you encountered.
14+
options:
15+
- label: I have searched the existing issues, known issues in release notes, and documentation.
16+
required: true
17+
- type: textarea
18+
id: brief-description
19+
attributes:
20+
label: Brief Description of the Documentation Issue or Improvement
21+
description: Briefly describe the issue you found and what you expected.
22+
placeholder: Tell us what you see!
23+
value: "The discrepancy can be found at ___ and I think it should be ___"
24+
validations:
25+
required: true
26+
- type: dropdown
27+
id: version
28+
attributes:
29+
label: Version
30+
description: What version of our software are you running? [Further details may be required during triage process]
31+
options:
32+
- DREAM3D NX (version 7.0.0+)
33+
- NXRunner built from source - Please provide git hash of commit in description
34+
- other (Please enter in the extended description at the bottom)
35+
validations:
36+
required: true
37+
- type: dropdown
38+
id: error-type
39+
attributes:
40+
label: What section of the documentation did you encounter the discrepancy in? [Further details may be required during triage process]
41+
multiple: true
42+
options:
43+
- Filter Documentation
44+
- Python Bindings Documentation
45+
- Release Notes
46+
- Acknowledgements
47+
- Licensing
48+
- README.md
49+
- CONTRIBUTING.md
50+
- SUPPORT.md
51+
- Other - Please provide additional information in the "Anything Else?" Section
52+
validations:
53+
required: false
54+
- type: textarea
55+
id: further-detail
56+
attributes:
57+
label: Anything else?
58+
description: |
59+
Is this in relation to multilingual support?
60+
Is there sections you think should be added to help other users?
61+
Is there a missing reference?
62+
63+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
64+
validations:
65+
required: false
66+
- type: checkboxes
67+
id: terms
68+
attributes:
69+
label: Code of Conduct
70+
description: By submitting this issue, you understand that your issue may be closed if you do not remain cordial, do not provide further detail if prompted, or do not engage with responses from the developers in a reasonable time.
71+
options:
72+
- label: I agree to follow this project's Code of Conduct
73+
required: true

‎.github/ISSUE_TEMPLATE/functionality_report.yml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
name: Request New Functionality
2+
description: Share your recommendations for new features, filters, and functionality!
3+
title: "ENH: "
4+
labels: ["enhancement", "needs triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
We're excited to hear your visions for our library. By filling out the following form in its entirety, we will be able to get a better understanding of your idea. Thank you in advance for taking the time to fill out the form!
10+
- type: checkboxes
11+
attributes:
12+
label: Is there an existing plan for this?
13+
description: Please search to see if a plan already exists for your suggestion. [If so, feel free to comment your support in that discussion/report]
14+
options:
15+
- label: I have searched the existing discussions, release notes, and documentation.
16+
required: true
17+
- type: textarea
18+
id: brief-description
19+
attributes:
20+
label: Description of the Feature, Filter, or Functionality?
21+
description: Describe your feature in detail or even provide an implementation plan/existing open source library to reference!
22+
value: What if simplnx had...
23+
validations:
24+
required: true
25+
- type: dropdown
26+
id: version
27+
attributes:
28+
label: Version
29+
description: What version of our software are you running? [Further details may be required during triage process]
30+
options:
31+
- 7.x.x+ (DREAM3DNX)
32+
- NXRunner built from source - Please provide git hash of commit in description
33+
- other (Please enter in the extended description at the bottom)
34+
validations:
35+
required: true
36+
- type: dropdown
37+
id: suggestion-type
38+
attributes:
39+
label: What section did you foresee your suggestion falling in? [Further details may be required during triage process]
40+
multiple: true
41+
options:
42+
- Python Bindings
43+
- NXRunner
44+
- Filter Library (or Search Bar)
45+
- Filter Parameters
46+
- Infrastructure
47+
- External Compatibility
48+
validations:
49+
required: false
50+
- type: textarea
51+
id: steps-to-implement
52+
attributes:
53+
label: High Level Steps To Implement
54+
description: Please include the steps to implement the behavior in order to help you as efficiently as possible.
55+
placeholder: |
56+
1. Based on this paper/library...
57+
2. Alter...
58+
validations:
59+
required: false
60+
- type: textarea
61+
id: further-detail
62+
attributes:
63+
label: Anything else?
64+
description: |
65+
Links? References? Anything that will give us more context about the issue you are encountering!
66+
67+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
68+
validations:
69+
required: false
70+
- type: checkboxes
71+
id: terms
72+
attributes:
73+
label: Code of Conduct
74+
description: By submitting this issue, you understand that your issue may be closed if you do not remain cordial, do not provide further detail if prompted, or do not engage with responses from the developers in a reasonable time.
75+
options:
76+
- label: I agree to follow this project's Code of Conduct
77+
required: true

‎.github/ISSUE_TEMPLATE/performance_report.yml‎

Lines changed: 96 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,96 @@
1+
name: Performance Report
2+
description: File a performance report
3+
title: "PERF: "
4+
labels: ["performance", "needs triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
We're sorry to hear your having trouble with our library. By filling out the following form in its entirety, we will be able to better diagnose the problem and help you reach a resolution. Thank you in advance for taking the time to fill out the form!
10+
- type: checkboxes
11+
attributes:
12+
label: Is there an existing issue for this?
13+
description: Please search to see if an issue already exists for the performance issue you encountered.
14+
options:
15+
- label: I have searched the existing issues, known issues in release notes, and documentation.
16+
required: true
17+
- type: textarea
18+
id: brief-description
19+
attributes:
20+
label: Brief Description of the Issue and Expected Behavior
21+
description: Briefly describe the issue you encountered and what you expected to happen.
22+
placeholder: Tell us what you see profiling wise.
23+
value: "This profile shows..."
24+
validations:
25+
required: true
26+
- type: textarea
27+
id: system-information
28+
attributes:
29+
label: Platform and Version Information
30+
description: |
31+
Please complete the following steps and paste it in the box below:
32+
33+
1. Select the `Help` dropdown from the taskbar at the top left side of the application
34+
2. Select the `About DREAM3D-NX` option near the bottom of the dropdown submenu
35+
3. Click the `Copy Info` button from the pop-up window to copy it to your clipboard
36+
4. Paste the information in the box below, using `ctrl-v` on the keyboard or by left-clicking and selecting `paste`
37+
38+
Example copied information shown in the preview.
39+
placeholder: |
40+
DREAM3D-NX Build Revision: cba61ebbca
41+
DREAM3D-NX Build Date: 2025/07/18
42+
Operating System: Ubuntu 22.04.5 LTS
43+
Architecture: x86_64
44+
System Locale: en_US
45+
Installed RAM: 62.5 GB
46+
Built and maintained by BlueQuartz Software, LLC.
47+
validations:
48+
required: true
49+
- type: dropdown
50+
id: error-type
51+
attributes:
52+
label: What section did you encounter the deprecated performance in? [Further details may be required during triage process]
53+
multiple: true
54+
options:
55+
- GUI client
56+
- NXRunner
57+
- Python Bindings
58+
- Specific filter
59+
validations:
60+
required: false
61+
- type: textarea
62+
id: steps-to-reproduce
63+
attributes:
64+
label: Steps To Reproduce
65+
description: Please include the steps to reproduce the behavior in order to help you as efficiently as possible.
66+
placeholder: |
67+
1. With this config...
68+
2. Run '...'
69+
validations:
70+
required: false
71+
- type: textarea
72+
id: logs
73+
attributes:
74+
label: Relevant log output
75+
description: Please copy and paste any relevant log output. This can be found in the output widget of the interface or the console output of PipelineRunner.
76+
render: "Text"
77+
validations:
78+
required: false
79+
- type: textarea
80+
id: further-detail
81+
attributes:
82+
label: Anything else?
83+
description: |
84+
Pipeline? Data? References? Compiler? Hardware? Anything that will give us more context about the issue you are encountering!
85+
86+
Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in.
87+
validations:
88+
required: false
89+
- type: checkboxes
90+
id: terms
91+
attributes:
92+
label: Code of Conduct
93+
description: By submitting this issue, you understand that your issue may be closed if you do not remain cordial, do not provide further detail if prompted, or do not engage with responses from the developers in a reasonable time.
94+
options:
95+
- label: I agree to follow this project's Code of Conduct
96+
required: true

0 commit comments

Comments
 (0)