Skip to content

Commit a7ff396

Browse files
hyperpolymathclaude
hyperpolymath
and
claude
authored
feat(github): issue templates (salvaged from superseded #41) (#47)
## What The salvageable result of fully integrating **#41** (`estate-standardization-20260607`) onto current `main`. I did the full 3-way merge as requested (option c); the **definitive finding** is that #41 is ~fully superseded: > A faithful integration of #41 onto current `main` nets to **exactly these 4 issue templates (195 insertions)** — every other file in #41's 70-file diff is already on `main` (your parallel estate-standardization in #37–#40 + our recent work landed it all), and its `.machine_readable/6a2/*.a2ml` changes were **regressive** (main renamed `6a2/ → descriptiles/`). So this PR carries the one piece worth keeping, cleanly off `main`: - `bug_report.md`, `feature_request.md` — #41's clean classic templates, as-is. - `question.yml`, `documentation.yml` — **#41 had these malformed** (classic markdown front-matter stacked on top of raw issue-forms YAML inside a single `.md`, which GitHub renders as literal text). Fixed into proper `.yml` issue forms, preserving the (good) forms schema. ## Recommendation **Close #41 as superseded** once this lands — merging #41 itself would regress `main` (resurrect `6a2/`, re-add the retired `scorecard-enforcer.yml`, revert the README). This PR is the salvage. Note: `main` currently lacks issue templates (they existed in #41's merge base but not on current `main`). If they were removed deliberately, just close this too — no harm done. 🤖 Generated with [Claude Code](https://claude.com/claude-code) https://claude.ai/code/session_01WN6nPWWe4dvXfoqBG6auWN --- _Generated by [Claude Code](https://claude.ai/code/session_01WN6nPWWe4dvXfoqBG6auWN)_ Co-authored-by: Claude <noreply@anthropic.com>
1 parent c4ebb45 commit a7ff396

4 files changed

Lines changed: 164 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!--
2+
SPDX-License-Identifier: MPL-2.0
3+
Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
4+
-->
5+
---
6+
name: Bug report
7+
about: Create a report to help us improve
8+
title: "[Bug]: "
9+
labels: 'bug, priority: unset, triage'
10+
assignees: ''
11+
12+
---
13+
14+
**Describe the bug**
15+
A clear and concise description of what the bug is.
16+
17+
**To Reproduce**
18+
Steps to reproduce the behavior:
19+
1. Go to '...'
20+
2. Click on '....'
21+
3. Scroll down to '....'
22+
4. See error
23+
24+
**Expected behavior**
25+
A clear and concise description of what you expected to happen.
26+
27+
**Screenshots**
28+
If applicable, add screenshots to help explain your problem.
29+
30+
**Desktop (please complete the following information):**
31+
- OS: [e.g. iOS]
32+
- Browser [e.g. chrome, safari]
33+
- Version [e.g. 22]
34+
35+
**Smartphone (please complete the following information):**
36+
- Device: [e.g. iPhone6]
37+
- OS: [e.g. iOS8.1]
38+
- Browser [e.g. stock browser, safari]
39+
- Version [e.g. 22]
40+
41+
**Additional context**
42+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/documentation.yml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# SPDX-License-Identifier: MPL-2.0
2+
# Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
3+
name: Documentation
4+
description: Report unclear, missing, or incorrect documentation
5+
title: "[Docs]: "
6+
labels: ["documentation", "triage"]
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Help us improve our documentation by reporting issues or gaps.
12+
- type: dropdown
13+
id: type
14+
attributes:
15+
label: Documentation issue type
16+
options:
17+
- Missing (documentation doesn't exist)
18+
- Incorrect (information is wrong)
19+
- Unclear (confusing or hard to follow)
20+
- Outdated (no longer accurate)
21+
- Typo or grammar
22+
validations:
23+
required: true
24+
- type: input
25+
id: location
26+
attributes:
27+
label: Location
28+
description: Where is this documentation? (URL, file path, or section name)
29+
placeholder: README.adoc, section "Installation"
30+
validations:
31+
required: true
32+
- type: textarea
33+
id: description
34+
attributes:
35+
label: Description
36+
description: What's the problem with the current documentation?
37+
placeholder: Describe what's wrong or missing
38+
validations:
39+
required: true
40+
- type: textarea
41+
id: suggestion
42+
attributes:
43+
label: Suggested improvement
44+
description: How should it be fixed or improved?
45+
placeholder: The documentation should say...
46+
validations:
47+
required: false
48+
- type: checkboxes
49+
id: contribution
50+
attributes:
51+
label: Contribution
52+
options:
53+
- label: I would be willing to submit a PR to fix this
54+
required: false

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<!--
2+
SPDX-License-Identifier: MPL-2.0
3+
Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
4+
-->
5+
---
6+
name: Feature request
7+
about: Suggest an idea for this project
8+
title: ''
9+
labels: 'enhancement, priority: unset, triage'
10+
assignees: ''
11+
12+
---
13+
14+
**Is your feature request related to a problem? Please describe.**
15+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
16+
17+
**Describe the solution you'd like**
18+
A clear and concise description of what you want to happen.
19+
20+
**Describe alternatives you've considered**
21+
A clear and concise description of any alternative solutions or features you've considered.
22+
23+
**Additional context**
24+
Add any other context or screenshots about the feature request here.

‎.github/ISSUE_TEMPLATE/question.yml‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
# SPDX-License-Identifier: MPL-2.0
2+
# Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
3+
name: Question
4+
description: Ask a question about usage or behaviour
5+
title: "[Question]: "
6+
labels: ["question", "triage"]
7+
body:
8+
- type: markdown
9+
attributes:
10+
value: |
11+
Have a question? You can also ask in [Discussions](../discussions) for broader conversations.
12+
- type: textarea
13+
id: question
14+
attributes:
15+
label: Your question
16+
description: What would you like to know?
17+
placeholder: How do I...?
18+
validations:
19+
required: true
20+
- type: textarea
21+
id: context
22+
attributes:
23+
label: Context
24+
description: Any relevant context that helps us answer your question
25+
placeholder: I'm trying to achieve X and I've tried Y...
26+
validations:
27+
required: false
28+
- type: textarea
29+
id: research
30+
attributes:
31+
label: What I've already tried
32+
description: What have you already looked at or attempted?
33+
placeholder: I've read the README and searched issues but...
34+
validations:
35+
required: false
36+
- type: checkboxes
37+
id: checked
38+
attributes:
39+
label: Pre-submission checklist
40+
options:
41+
- label: I have searched existing issues and discussions
42+
required: true
43+
- label: I have read the documentation
44+
required: true

0 commit comments

Comments
 (0)