Skip to content

Commit 4b90ada

Browse files
MarkusNeusingerMarkusNeusinger
committed
feat: update issue templates and documentation
- Change spec request template link in CatalogPage - Update report issue URL construction in SpecPage - Consolidate issue reporting templates in contributing.md - Revise plot issue reporting process in overview.md - Add new report-plot-issue.yml template for reporting plot issues - Update README with new plot request link
1 parent 5b6607b commit 4b90ada

File tree

11 files changed

+134
-189
lines changed

11 files changed

+134
-189
lines changed

‎.github/ISSUE_TEMPLATE/report-impl-issue.yml‎

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

‎.github/ISSUE_TEMPLATE/report-plot-issue.yml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
name: Report Plot Issue
2+
description: Report a problem with an existing plot (specification or implementation)
3+
labels: ["report-pending"]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
## Report Plot Issue
9+
10+
Found something wrong with a plot? Use this form to report it.
11+
12+
- type: input
13+
id: spec_id
14+
attributes:
15+
label: Specification ID
16+
description: The spec ID from the URL (e.g., scatter-basic, raincloud-basic)
17+
placeholder: scatter-basic
18+
validations:
19+
required: true
20+
21+
- type: checkboxes
22+
id: library
23+
attributes:
24+
label: Affected Libraries
25+
description: Select which libraries have this issue. Leave all unchecked if it affects all or you're unsure.
26+
options:
27+
- label: matplotlib
28+
- label: seaborn
29+
- label: plotly
30+
- label: bokeh
31+
- label: altair
32+
- label: plotnine
33+
- label: pygal
34+
- label: highcharts
35+
- label: letsplot
36+
37+
- type: dropdown
38+
id: category
39+
attributes:
40+
label: Category
41+
description: What type of issue is this?
42+
options:
43+
- Visual (design, clarity, hard to read)
44+
- Data (unrealistic values, inappropriate context)
45+
- Functional (doesn't work as expected)
46+
- Other / Not sure
47+
validations:
48+
required: false
49+
50+
- type: textarea
51+
id: description
52+
attributes:
53+
label: Description
54+
description: Describe the problem. Include screenshots or links to preview images if helpful.
55+
placeholder: |
56+
What's wrong:
57+
...
58+
59+
Expected:
60+
...
61+
validations:
62+
required: true

‎.github/ISSUE_TEMPLATE/report-spec-issue.yml‎

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

.github/ISSUE_TEMPLATE/spec-request.yml renamed to .github/ISSUE_TEMPLATE/request-new-plot.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
name: Request Specification
2-
description: Propose a new visualization type for pyplots
1+
name: Request New Plot
2+
description: Propose a new plot type for pyplots
33
labels: ["spec-request"]
44
body:
55
- type: markdown
66
attributes:
77
value: |
8-
## New Specification Request
8+
## Request New Plot
99
10-
Describe the visualization you'd like to see. Our AI will:
10+
Describe the plot you'd like to see. Our AI will:
1111
1. Check for similar existing specifications
1212
2. Assign a spec ID (e.g., `scatter-regression-linear`)
1313
3. Create the specification for review

‎.github/workflows/project-auto-add.yml‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
name: Auto-add issues to project board
2+
3+
on:
4+
issues:
5+
types: [labeled]
6+
7+
jobs:
8+
add-to-project:
9+
runs-on: ubuntu-latest
10+
if: contains(fromJSON('["report-pending", "spec-request"]'), github.event.label.name)
11+
steps:
12+
- name: Add to project
13+
uses: actions/add-to-project@v1.0.2
14+
with:
15+
project-url: https://github.com/users/MarkusNeusinger/projects/8
16+
github-token: ${{ secrets.PROJECT_TOKEN }}

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,6 @@ MIT License - see [LICENSE](LICENSE) file for details.
166166

167167
**Built by [Markus Neusinger](https://linkedin.com/in/markus-neusinger/)**
168168

169-
[⭐ Star us on GitHub](https://github.com/MarkusNeusinger/pyplots) • [💡 Suggest Spec](https://github.com/MarkusNeusinger/pyplots/issues/new?template=spec-request.yml)
169+
[⭐ Star us on GitHub](https://github.com/MarkusNeusinger/pyplots) • [💡 Request New Plot](https://github.com/MarkusNeusinger/pyplots/issues/new?template=request-new-plot.yml)
170170

171171
</div>

‎app/src/pages/CatalogPage.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,7 +194,7 @@ export function CatalogPage() {
194194
{/* Suggest spec link */}
195195
<Box
196196
component="a"
197-
href={`${GITHUB_URL}/issues/new?template=spec-request.yml`}
197+
href={`${GITHUB_URL}/issues/new?template=request-new-plot.yml`}
198198
target="_blank"
199199
rel="noopener noreferrer"
200200
onClick={() => trackEvent('suggest_spec')}

‎app/src/pages/SpecPage.tsx‎

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -182,17 +182,13 @@ export function SpecPage() {
182182

183183
// Build report issue URL
184184
const buildReportUrl = useCallback(() => {
185-
const params = new URLSearchParams({ spec_id: specId || '' });
186-
187-
if (selectedLibrary) {
188-
params.set('template', 'report-impl-issue.yml');
189-
params.set('library', selectedLibrary);
190-
} else {
191-
params.set('template', 'report-spec-issue.yml');
192-
}
185+
const params = new URLSearchParams({
186+
template: 'report-plot-issue.yml',
187+
spec_id: specId || '',
188+
});
193189

194190
return `${GITHUB_URL}/issues/new?${params.toString()}`;
195-
}, [specId, selectedLibrary]);
191+
}, [specId]);
196192

197193
// Track page view
198194
useEffect(() => {

‎docs/contributing.md‎

Lines changed: 10 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,18 @@ pyplots is a specification-driven platform where **AI generates all plot impleme
66

77
---
88

9-
## Three Ways to Contribute
9+
## Two Ways to Contribute
1010

1111
| Action | When to Use | From pyplots.ai |
1212
|--------|-------------|-----------------|
13-
| **[Suggest Spec](#suggest-a-new-plot-type)** | Propose a new plot type | Click "suggest spec" in catalog |
14-
| **[Report Spec Issue](#report-a-spec-issue)** | Problem with a specification | Click "report issue" on spec page |
15-
| **[Report Impl Issue](#report-an-impl-issue)** | Problem with a library implementation | Click "report issue" on impl page |
13+
| **[Request New Plot](#request-a-new-plot)** | Propose a new plot type | Click "suggest spec" in catalog |
14+
| **[Report Plot Issue](#report-a-plot-issue)** | Problem with a spec or implementation | Click "report issue" on any page |
1615

1716
All contributions go through GitHub Issues with AI-powered validation and processing.
1817

1918
---
2019

21-
## Suggest a New Plot Type
20+
## Request a New Plot
2221

2322
1. **Create a GitHub Issue** with a descriptive title (e.g., "Radar Chart with Multiple Series")
2423
- Do NOT include spec-id in the title
@@ -33,27 +32,14 @@ All contributions go through GitHub Issues with AI-powered validation and proces
3332

3433
---
3534

36-
## Report a Spec Issue
35+
## Report a Plot Issue
3736

38-
Found a problem with a specification (affects all libraries)?
37+
Found a problem with a plot (specification or implementation)?
3938

40-
1. **From pyplots.ai**: Navigate to the spec page (e.g., `/scatter-basic`) and click "report issue"
41-
2. **From GitHub**: Create issue using the [Report Specification Issue](https://github.com/MarkusNeusinger/pyplots/issues/new?template=report-spec-issue.yml) template
42-
3. **Choose a category**: Visual, Data, Functional, or Other (optional)
43-
4. **Describe the issue**
44-
45-
AI validates your report and adds structured analysis. Maintainers review and approve fixes.
46-
47-
---
48-
49-
## Report an Impl Issue
50-
51-
Found a problem with a specific library implementation?
52-
53-
1. **From pyplots.ai**: Navigate to the impl page (e.g., `/scatter-basic/matplotlib`) and click "report issue"
54-
2. **From GitHub**: Create issue using the [Report Implementation Issue](https://github.com/MarkusNeusinger/pyplots/issues/new?template=report-impl-issue.yml) template
55-
3. **Enter the library name** (matplotlib, seaborn, etc.)
56-
4. **Choose a category**: Visual, Data, Functional, or Other (optional)
39+
1. **From pyplots.ai**: Click "report issue" on any spec or implementation page
40+
2. **From GitHub**: Use the [Report Plot Issue](https://github.com/MarkusNeusinger/pyplots/issues/new?template=report-plot-issue.yml) template
41+
3. **Select affected libraries** (or leave empty if all/unsure)
42+
4. **Choose a category** (optional): Visual, Data, Functional, or Other
5743
5. **Describe the issue**
5844

5945
AI validates your report and adds structured analysis. Maintainers review and approve fixes.

0 commit comments

Comments
 (0)