Skip to content

Commit a5ad221

Browse files
simonprovostsimonprovost
committed
refactor(workflow): improve ISSUES template into YAML
1 parent ace3731 commit a5ad221

File tree

6 files changed

+319
-145
lines changed

6 files changed

+319
-145
lines changed

‎.github/ISSUE_TEMPLATE/ask_question.md‎

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

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 155 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,155 @@
1+
name: "🐛 Bug Report"
2+
description: Report a bug or unexpected behavior in UrbanMapper.
3+
title: "🐛 [BUG] - <short summary>"
4+
labels:
5+
- "bug"
6+
assignees:
7+
- soniacq
8+
- fabiofelix
9+
- simonprovost
10+
body:
11+
- type: markdown
12+
attributes:
13+
value: |
14+
<p align="center">
15+
<div align="center">
16+
<picture>
17+
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/simonprovost/VIDA-NYU/UrbanMapper/raw/main/docs/public/resources/oscur_logo_light.png" width="400px">
18+
<source media="(prefers-color-scheme: light)" srcset="https://github.com/simonprovost/VIDA-NYU/UrbanMapper/raw/main/docs/public/resources/oscur_logo_dark.png" width="400px">
19+
<img alt="Fallback image description" src="https://github.com/VIDA-NYU/UrbanMapper/raw/main/docs/public/resources/oscur_logo_dark.png" width="200px">
20+
</picture>
21+
<br />
22+
<em>UrbanMapper</em> • <a href="https://urbanmapper.readthedocs.io/en/latest/">Docs</a> • <a href="https://github.com/VIDA-NYU/UrbanMapper">Repo</a>
23+
</div>
24+
</p>
25+
26+
- type: checkboxes
27+
id: checks
28+
attributes:
29+
label: "Before Submitting"
30+
description: Please confirm the following to help us triage efficiently.
31+
options:
32+
- label: I have checked the documentation and searched existing issues.
33+
required: true
34+
- label: This report does not contain secrets or sensitive data (API keys, tokens, PII).
35+
required: true
36+
37+
- type: textarea
38+
id: description
39+
attributes:
40+
label: "Description"
41+
description: What happened? A clear, concise description of the problem.
42+
placeholder: "Describe the bug you encountered…"
43+
validations:
44+
required: true
45+
46+
- type: input
47+
id: repro-url
48+
attributes:
49+
label: "Minimal Reproduction (URL)"
50+
description: Link to a minimal repo / gist / notebook that reproduces the issue.
51+
placeholder: "e.g., https://gist.github.com/..."
52+
validations:
53+
required: false
54+
55+
- type: textarea
56+
id: steps
57+
attributes:
58+
label: "Steps to Reproduce"
59+
description: Exact steps/commands to reproduce the issue.
60+
value: |
61+
1. ...
62+
2. ...
63+
3. ...
64+
render: bash
65+
validations:
66+
required: true
67+
68+
- type: textarea
69+
id: expected
70+
attributes:
71+
label: "Expected Behavior"
72+
description: What did you expect to happen?
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: actual
78+
attributes:
79+
label: "Actual Behavior"
80+
description: What actually happened? Include full error trace if applicable.
81+
render: bash
82+
validations:
83+
required: true
84+
85+
- type: markdown
86+
attributes:
87+
value: "### Environment"
88+
89+
- type: dropdown
90+
id: os
91+
attributes:
92+
label: "Operating System"
93+
options:
94+
- "Windows"
95+
- "macOS"
96+
- "Linux"
97+
- "Other"
98+
validations:
99+
required: true
100+
101+
- type: input
102+
id: os-version
103+
attributes:
104+
label: "OS Version (if 'Other')"
105+
placeholder: "e.g., Ubuntu 22.04"
106+
107+
- type: input
108+
id: python-version
109+
attributes:
110+
label: "Python Version"
111+
placeholder: "e.g., 3.11.7"
112+
validations:
113+
required: true
114+
115+
- type: input
116+
id: urbanmapper-version
117+
attributes:
118+
label: "UrbanMapper Version"
119+
placeholder: "e.g., 0.x.y (pip show urban-mapper)"
120+
validations:
121+
required: true
122+
123+
- type: dropdown
124+
id: installation
125+
attributes:
126+
label: "Installation Method"
127+
options:
128+
- "UV"
129+
- "pip"
130+
- "conda/mamba"
131+
- "source (git)"
132+
- "other"
133+
134+
- type: dropdown
135+
id: runtime
136+
attributes:
137+
label: "Runtime / IDE"
138+
options:
139+
- "Jupyter Notebook"
140+
- "JupyterLab"
141+
- "VS Code"
142+
- "PyCharm"
143+
- "CLI only"
144+
- "Other"
145+
146+
- type: textarea
147+
id: attachments
148+
attributes:
149+
label: "Logs / Screenshots / Additional Context"
150+
description: Drag & drop images or paste logs here.
151+
152+
- type: markdown
153+
attributes:
154+
value: |
155+
**Security Note:** Please do not share tokens, API keys, or personal data in this report.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

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

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: "💡 Feature Request"
2+
description: Suggest a new feature or enhancement for UrbanMapper.
3+
title: "💡 [FEAT] - <short summary>"
4+
labels:
5+
- "feature"
6+
assignees:
7+
- soniacq
8+
- fabiofelix
9+
- simonprovost
10+
body:
11+
- type: markdown
12+
attributes:
13+
value: |
14+
<p align="center">
15+
<div align="center">
16+
<picture>
17+
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/simonprovost/VIDA-NYU/UrbanMapper/raw/main/docs/public/resources/oscur_logo_light.png" width="400px">
18+
<source media="(prefers-color-scheme: light)" srcset="https://github.com/simonprovost/VIDA-NYU/UrbanMapper/raw/main/docs/public/resources/oscur_logo_dark.png" width="400px">
19+
<img alt="Fallback image description" src="https://github.com/VIDA-NYU/UrbanMapper/raw/main/docs/public/resources/oscur_logo_dark.png" width="200px">
20+
</picture>
21+
<br />
22+
<em>UrbanMapper</em> • <a href="https://urbanmapper.readthedocs.io/en/latest/">Docs</a> • <a href="https://github.com/VIDA-NYU/UrbanMapper">Repo</a>
23+
</div>
24+
</p>
25+
26+
- type: checkboxes
27+
id: checks
28+
attributes:
29+
label: "Before Submitting"
30+
description: Please confirm the following.
31+
options:
32+
- label: I checked if this feature already exists or has been requested.
33+
required: true
34+
35+
- type: textarea
36+
id: problem
37+
attributes:
38+
label: "Problem / Motivation"
39+
description: What problem are you trying to solve? Why is it important?
40+
validations:
41+
required: true
42+
43+
- type: textarea
44+
id: proposal
45+
attributes:
46+
label: "Proposed Solution"
47+
description: Describe how the feature should work. Include API, CLI, or UX details if relevant.
48+
placeholder: "Explain inputs/outputs, configuration, examples…"
49+
validations:
50+
required: true
51+
52+
- type: dropdown
53+
id: area
54+
attributes:
55+
label: "Area / Component"
56+
description: Which part of UrbanMapper does this touch?
57+
options:
58+
- "Loader"
59+
- "Imputer"
60+
- "Filter"
61+
- "Enricher"
62+
- "UrbanLayer"
63+
- "Pipeline"
64+
- "Pipeline Generator"
65+
- "Visualiser"
66+
- "JupyterGIS"
67+
- "Auctus Search"
68+
- "Docs & Examples"
69+
- "Other"
70+
71+
- type: textarea
72+
id: examples
73+
attributes:
74+
label: "Examples / References"
75+
description: Links, screenshots, or pseudo-code that illustrate the idea.
76+
validations:
77+
required: false
78+
79+
- type: dropdown
80+
id: contribution
81+
attributes:
82+
label: "Willing to Contribute?"
83+
options:
84+
- "Yes"
85+
- "No"
86+
87+
- type: markdown
88+
attributes:
89+
value: |
90+
**Security Note:** Please do not share sensitive information in this request.

0 commit comments

Comments
 (0)