Skip to content

Commit b204b45

Browse files
committed
Merge pull request #5533 from NREL/github_issue_forms
Issue templates: replace with GitHub issue forms
2 parents 9778fd6 + 9251b2a commit b204b45

File tree

14 files changed

+1729
-353
lines changed

14 files changed

+1729
-353
lines changed
Lines changed: 157 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,157 @@
1+
name: Bug Report
2+
description: Use this template for reporting an issue.
3+
labels: Triage
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to submit a report.
9+
Include all applicable information to help us reproduce
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Description
15+
description: |
16+
Provide a general summary of the issue .
17+
placeholder: When trying to connect a CoilCoolingDXSingleSpeed to an AirLoopHVAC, I get a crash
18+
validations:
19+
required: true
20+
21+
- type: textarea
22+
id: current_behavior
23+
attributes:
24+
label: Current Behavior
25+
description: Tell us what happens instead of the expected behavior.
26+
placeholder: When trying to do X, I get Y
27+
validations:
28+
required: true
29+
30+
- type: textarea
31+
id: expected_behavior
32+
attributes:
33+
label: Expected Behavior
34+
description: Tell us what happens instead of the expected behavior.
35+
placeholder: What I get instead is Z
36+
validations:
37+
required: true
38+
39+
- type: textarea
40+
id: steps
41+
attributes:
42+
label: Steps to reproduce
43+
description: |
44+
Provide an unambiguous set of steps to reproduce this bug.
45+
46+
Provide a OSM model that has the bug and/or code (Ruby, Python) to reproduce.
47+
48+
You **can supply a link to your OSM if applicable**, or rename it to in.osm.txt and upload it directly here by drag and drop.
49+
Ideally, make it a _Minimum, Complete, Verifiable, Example (MCVE)_ by including the smallest possible number of input objects to reproduce the defect.
50+
51+
placeholder: |
52+
1. Create a '...'
53+
2. Connect it to '....'
54+
3. See error
55+
value: |
56+
1.
57+
2.
58+
3.
59+
4.
60+
61+
or
62+
63+
```ruby
64+
require 'openstudio'
65+
include OpenStudio::Model
66+
m = Model.new
67+
# m = Model.load('path/to/model.osm').get
68+
[...]
69+
```
70+
validations:
71+
required: true
72+
73+
- type: textarea
74+
id: possible_solution
75+
attributes:
76+
label: Possible Solution
77+
description: |
78+
Optional, but if you can, suggest a fix/reason for the bug
79+
validations:
80+
required: false
81+
82+
- type: dropdown
83+
id: operating_system_multiple
84+
attributes:
85+
label: Operating System affected
86+
multiple: true
87+
description: You may select more than one.
88+
options:
89+
- All
90+
- macOS x86_64
91+
- macOS arm64
92+
- Ubuntu 22.04
93+
- Ubuntu 24.04
94+
- Windows 10
95+
- Windows 11
96+
97+
- type: textarea
98+
id: env
99+
attributes:
100+
label: Environment
101+
description: |
102+
Some additional details about your environment for this issue (if relevant)
103+
104+
To get your platform info, you can run the following commands in your terminal
105+
106+
<details>
107+
108+
<summary>Helpers: click to expand</summary>
109+
110+
* Linux:
111+
112+
```bash
113+
echo "* Platform (Operating system, version, architecture): **$(lsb_release -is) $(lsb_release -rs) $(uname -m)**"
114+
```
115+
116+
* macOS:
117+
118+
```bash
119+
echo "* Platform (Operating system, version, architecture): **$(sw_vers -productName) $(sw_vers -productVersion) $(uname -m)**"
120+
```
121+
122+
* Windows (PowerShell):
123+
124+
```powershell
125+
$os = Get-CimInstance Win32_OperatingSystem
126+
$release = (Get-ItemProperty "HKLM:\SOFTWARE\Microsoft\Windows NT\CurrentVersion").DisplayVersion
127+
Write-Output "* Platform (Operating system, version, architecture): **$($os.Caption) $($os.Version) $release $env:PROCESSOR_ARCHITECTURE**"
128+
```
129+
</details>
130+
131+
placeholder: |
132+
* Platform (Operating system, version, architecture): **Linux Ubuntu 24.04**
133+
or
134+
N/A
135+
validations:
136+
required: true
137+
138+
- type: input
139+
id: os_version
140+
attributes:
141+
label: Version of OpenStudio
142+
description: |
143+
Version of OpenStudio (if using an intermediate build, include SHA). `openstudio --version`
144+
placeholder: |
145+
3.10.0+86d7e215a1
146+
validations:
147+
required: true
148+
149+
- type: textarea
150+
id: context
151+
attributes:
152+
label: Context
153+
description: |
154+
How has this issue affected you? What are you trying to accomplish?
155+
Any link to related issues or UnmetHours post?
156+
validations:
157+
required: false
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: Enhancement Request
2+
description: Use this template for suggesting an enhancement.
3+
labels: Triage, Enhancement Request
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thanks for taking the time to submit a report.
9+
Include all applicable information to help us reproduce.
10+
11+
- type: textarea
12+
id: summary
13+
attributes:
14+
label: General Summary
15+
description: |
16+
Provide a general summary of the feature you would like to see implemented
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: details
22+
attributes:
23+
label: Detailed Description
24+
description: |
25+
Provide a detailed description of the change or addition you are proposing.
26+
27+
Include screenshots, schemas, OSM/IDD snippets as appropriate.
28+
validations:
29+
required: true
30+
31+
- type: textarea
32+
id: implementation
33+
attributes:
34+
label: Possible Implementation
35+
description: |
36+
Not mandatory, but if you can, suggest an idea for implementing the feature
37+
validations:
38+
required: false

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Unmet Hours
4+
url: https://unmethours.com
5+
about: "Ask modeling **questions** on unmethours.com"

.github/ISSUE_TEMPLATE/enhancement_request.md

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

.github/signing-client/code-signing.js

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

.github/signing-client/sign.bat

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
@ECHO OFF
2+
node code-signing.js %1

0 commit comments

Comments
 (0)