Skip to content

Commit 96afb36

Browse files
soniacqsoniacq
authored
Merge pull request #78 from VIDA-NYU/refactor/best_practices_docs
Support Gray-Mode + Github Issues Modernisation
2 parents 39f2640 + 6187b8f commit 96afb36

20 files changed

+349
-160
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: 153 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
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+
<img alt="OSCUR LOGO" src="https://github.com/VIDA-NYU/UrbanMapper/raw/main/docs/public/resources/oscur_logo_gray.png" width="200px">
18+
</picture>
19+
<br />
20+
<em>UrbanMapper</em> • <a href="https://urbanmapper.readthedocs.io/en/latest/">Docs</a> • <a href="https://github.com/VIDA-NYU/UrbanMapper">Repo</a>
21+
</div>
22+
</p>
23+
24+
- type: checkboxes
25+
id: checks
26+
attributes:
27+
label: "Before Submitting"
28+
description: Please confirm the following to help us triage efficiently.
29+
options:
30+
- label: I have checked the documentation and searched existing issues.
31+
required: true
32+
- label: This report does not contain secrets or sensitive data (API keys, tokens, PII).
33+
required: true
34+
35+
- type: textarea
36+
id: description
37+
attributes:
38+
label: "Description"
39+
description: What happened? A clear, concise description of the problem.
40+
placeholder: "Describe the bug you encountered…"
41+
validations:
42+
required: true
43+
44+
- type: input
45+
id: repro-url
46+
attributes:
47+
label: "Minimal Reproduction (URL)"
48+
description: Link to a minimal repo / gist / notebook that reproduces the issue.
49+
placeholder: "e.g., https://gist.github.com/..."
50+
validations:
51+
required: false
52+
53+
- type: textarea
54+
id: steps
55+
attributes:
56+
label: "Steps to Reproduce"
57+
description: Exact steps/commands to reproduce the issue.
58+
value: |
59+
1. ...
60+
2. ...
61+
3. ...
62+
render: bash
63+
validations:
64+
required: true
65+
66+
- type: textarea
67+
id: expected
68+
attributes:
69+
label: "Expected Behavior"
70+
description: What did you expect to happen?
71+
validations:
72+
required: true
73+
74+
- type: textarea
75+
id: actual
76+
attributes:
77+
label: "Actual Behavior"
78+
description: What actually happened? Include full error trace if applicable.
79+
render: bash
80+
validations:
81+
required: true
82+
83+
- type: markdown
84+
attributes:
85+
value: "### Environment"
86+
87+
- type: dropdown
88+
id: os
89+
attributes:
90+
label: "Operating System"
91+
options:
92+
- "Windows"
93+
- "macOS"
94+
- "Linux"
95+
- "Other"
96+
validations:
97+
required: true
98+
99+
- type: input
100+
id: os-version
101+
attributes:
102+
label: "OS Version (if 'Other')"
103+
placeholder: "e.g., Ubuntu 22.04"
104+
105+
- type: input
106+
id: python-version
107+
attributes:
108+
label: "Python Version"
109+
placeholder: "e.g., 3.11.7"
110+
validations:
111+
required: true
112+
113+
- type: input
114+
id: urbanmapper-version
115+
attributes:
116+
label: "UrbanMapper Version"
117+
placeholder: "e.g., 0.x.y (pip show urban-mapper)"
118+
validations:
119+
required: true
120+
121+
- type: dropdown
122+
id: installation
123+
attributes:
124+
label: "Installation Method"
125+
options:
126+
- "UV"
127+
- "pip"
128+
- "conda/mamba"
129+
- "source (git)"
130+
- "other"
131+
132+
- type: dropdown
133+
id: runtime
134+
attributes:
135+
label: "Runtime / IDE"
136+
options:
137+
- "Jupyter Notebook"
138+
- "JupyterLab"
139+
- "VS Code"
140+
- "PyCharm"
141+
- "CLI only"
142+
- "Other"
143+
144+
- type: textarea
145+
id: attachments
146+
attributes:
147+
label: "Logs / Screenshots / Additional Context"
148+
description: Drag & drop images or paste logs here.
149+
150+
- type: markdown
151+
attributes:
152+
value: |
153+
**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: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
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+
<img alt="OSCUR LOGO" src="https://github.com/VIDA-NYU/UrbanMapper/raw/main/docs/public/resources/oscur_logo_gray.png" width="200px">
18+
</picture>
19+
<br />
20+
<em>UrbanMapper</em> • <a href="https://urbanmapper.readthedocs.io/en/latest/">Docs</a> • <a href="https://github.com/VIDA-NYU/UrbanMapper">Repo</a>
21+
</div>
22+
</p>
23+
24+
- type: checkboxes
25+
id: checks
26+
attributes:
27+
label: "Before Submitting"
28+
description: Please confirm the following.
29+
options:
30+
- label: I checked if this feature already exists or has been requested.
31+
required: true
32+
33+
- type: textarea
34+
id: problem
35+
attributes:
36+
label: "Problem / Motivation"
37+
description: What problem are you trying to solve? Why is it important?
38+
validations:
39+
required: true
40+
41+
- type: textarea
42+
id: proposal
43+
attributes:
44+
label: "Proposed Solution"
45+
description: Describe how the feature should work. Include API, CLI, or UX details if relevant.
46+
placeholder: "Explain inputs/outputs, configuration, examples…"
47+
validations:
48+
required: true
49+
50+
- type: dropdown
51+
id: area
52+
attributes:
53+
label: "Area / Component"
54+
description: Which part of UrbanMapper does this touch?
55+
options:
56+
- "Loader"
57+
- "Imputer"
58+
- "Filter"
59+
- "Enricher"
60+
- "UrbanLayer"
61+
- "Pipeline"
62+
- "Pipeline Generator"
63+
- "Visualiser"
64+
- "JupyterGIS"
65+
- "Auctus Search"
66+
- "Docs & Examples"
67+
- "Other"
68+
69+
- type: textarea
70+
id: examples
71+
attributes:
72+
label: "Examples / References"
73+
description: Links, screenshots, or pseudo-code that illustrate the idea.
74+
validations:
75+
required: false
76+
77+
- type: dropdown
78+
id: contribution
79+
attributes:
80+
label: "Willing to Contribute?"
81+
options:
82+
- "Yes"
83+
- "No"
84+
85+
- type: markdown
86+
attributes:
87+
value: |
88+
**Security Note:** Please do not share sensitive information in this request.

0 commit comments

Comments
 (0)