Skip to content

Commit a4ddea4

Browse files
feat: update issue reporting templates and specifications
- Rename "Plot Request" to "Request Specification" in spec-request.yml - Add new report-impl-issue.yml template for implementation issues - Add new report-spec-issue.yml template for specification issues - Update SpecPage.tsx to use new templates based on issue type - Enhance overview.md with details about new templates
1 parent 4db1792 commit a4ddea4

File tree

11 files changed

+148
-537
lines changed

11 files changed

+148
-537
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Report Implementation Issue
2+
description: Report a problem with a specific library implementation
3+
labels: ["report-pending"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Report Implementation Issue
9+
10+
Use this form to report problems with a **specific library implementation**.
11+
12+
For issues that affect all libraries (specification problems), use [Report Spec Issue](https://github.com/MarkusNeusinger/pyplots/issues/new?template=report-spec-issue.yml) instead.
13+
14+
- type: input
15+
id: spec_id
16+
attributes:
17+
label: Specification ID
18+
description: The spec ID from the URL (e.g., scatter-basic)
19+
placeholder: scatter-basic
20+
validations:
21+
required: true
22+
23+
- type: input
24+
id: library
25+
attributes:
26+
label: Library
27+
description: Which library implementation has the issue?
28+
placeholder: matplotlib
29+
validations:
30+
required: true
31+
32+
- type: checkboxes
33+
id: affects_others
34+
attributes:
35+
label: Scope
36+
options:
37+
- label: Also affects other libraries
38+
39+
- type: dropdown
40+
id: category
41+
attributes:
42+
label: Category
43+
description: What type of issue is this?
44+
options:
45+
- Visual (design, clarity, hard to read)
46+
- Data (unrealistic values, inappropriate context)
47+
- Functional (doesn't work as expected)
48+
- Other
49+
validations:
50+
required: true
51+
52+
- type: textarea
53+
id: description
54+
attributes:
55+
label: Issue Description
56+
description: Describe the problem. Include screenshots if helpful.
57+
placeholder: |
58+
What's wrong:
59+
The implementation shows X but should show Y...
60+
61+
Expected behavior:
62+
The plot should...
63+
validations:
64+
required: true

.github/ISSUE_TEMPLATE/report-issue.yml

Lines changed: 0 additions & 85 deletions
This file was deleted.
Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Report Specification Issue
2+
description: Report a problem with a plot specification (affects all libraries)
3+
labels: ["report-pending"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Report Specification Issue
9+
10+
Use this form to report problems with a **specification** that affects all library implementations.
11+
12+
For issues with a specific library implementation, use [Report Implementation Issue](https://github.com/MarkusNeusinger/pyplots/issues/new?template=report-impl-issue.yml) instead.
13+
14+
- type: input
15+
id: spec_id
16+
attributes:
17+
label: Specification ID
18+
description: The spec ID from the URL (e.g., scatter-basic)
19+
placeholder: scatter-basic
20+
validations:
21+
required: true
22+
23+
- type: dropdown
24+
id: category
25+
attributes:
26+
label: Category
27+
description: What type of issue is this?
28+
options:
29+
- Visual (design, clarity, hard to read)
30+
- Data (unrealistic values, inappropriate context)
31+
- Functional (doesn't work as expected)
32+
- Other
33+
validations:
34+
required: true
35+
36+
- type: textarea
37+
id: description
38+
attributes:
39+
label: Issue Description
40+
description: Describe the problem. Include screenshots if helpful.
41+
placeholder: |
42+
What's wrong:
43+
The specification describes X but should describe Y...
44+
45+
Expected behavior:
46+
The plot should...
47+
validations:
48+
required: true

.github/ISSUE_TEMPLATE/spec-request.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Plot Request
1+
name: Request Specification
22
description: Propose a new plot type for pyplots
33
labels: ["spec-request"]
44
body:

.github/ISSUE_TEMPLATE/spec-update.yml

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

.github/workflows/report-validate.yml

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,15 @@ jobs:
8181
8282
2. **Parse the issue body** to extract:
8383
- spec_id (from "Specification ID" field)
84-
- target (Specification or Implementation)
85-
- library (if implementation)
84+
- library (if present - only in impl issues)
85+
- affects_others (check for `- [x] Also affects other libraries`)
8686
- category (Visual/Data/Functional/Other)
8787
- description
8888
89+
**Determine issue type:**
90+
- If "Library" field exists → Implementation issue
91+
- If no "Library" field → Specification issue
92+
8993
3. **Validate the spec exists:**
9094
```bash
9195
ls plots/{spec_id}/
@@ -122,15 +126,16 @@ jobs:
122126
# Remove pending, add validated
123127
gh issue edit ${{ github.event.issue.number }} --remove-label "report-pending" --add-label "report-validated"
124128
125-
# Add target label
129+
# Add target label based on issue type
130+
# For spec issues:
126131
gh issue edit ${{ github.event.issue.number }} --add-label "report:spec"
127-
# OR for impl:
132+
# For impl issues:
128133
gh issue edit ${{ github.event.issue.number }} --add-label "report:impl" --add-label "report:impl:{library}"
129134
130135
# Add category label (map from dropdown value)
131-
# Visual → category:visual
132-
# Data → category:data
133-
# Functional → category:functional
136+
# Visual... → category:visual
137+
# Data... → category:data
138+
# Functional... → category:functional
134139
# Other → category:other
135140
gh issue edit ${{ github.event.issue.number }} --add-label "category:{category}"
136141
```

0 commit comments

Comments
 (0)