Skip to content

Commit afa49c4

Browse files
committed
Add GitHub Issue Templates
1 parent 2021b79 commit afa49c4

File tree

4 files changed

+151
-0
lines changed

4 files changed

+151
-0
lines changed

.github/ISSUE_TEMPLATE/bug-report.yml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Bug report
2+
description: Report an error or unexpected behavior
3+
labels: ['t: bug', 's: triage-needed']
4+
title: "[Bug]: "
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Welcome to the quarto-pyodide Extension GitHub repository!
10+
11+
We're sorry to hear that you might have encounter a bug; we're happy that you want to let us know so that we can make the extension even better.
12+
13+
Thank you in advance for your feedback.
14+
15+
- type: textarea
16+
attributes:
17+
label: Bug description
18+
description: Description of the bug and why you think its a bug.
19+
placeholder: Please describe the bug here.
20+
21+
- type: textarea
22+
attributes:
23+
label: Steps to reproduce
24+
description: |
25+
Tell us how to reproduce this bug.
26+
27+
Please include a minimal, fully reproducible example as a self-contained Quarto document or a link to a Git repository.
28+
placeholder: |
29+
You can share a Quarto document using the following syntax, _i.e._, using more backticks than you have in your document (usually four ` ```` `).
30+
31+
````qmd
32+
---
33+
title: "Reproducible pyodide powered Quarto Document"
34+
format: html
35+
filter:
36+
- pyodide
37+
---
38+
39+
This is a reproducible Quarto document using `format: html` with
40+
the `pyodide` filter active. It contains a pyodide code cell that
41+
should create a plot using the cars data.
42+
43+
```{pyodide-python}
44+
[x**2 for x in range(0, 5)]
45+
```
46+
47+
The end.
48+
````
49+
50+
- type: textarea
51+
attributes:
52+
label: Your environment
53+
description: |
54+
Please document the IDE (_e.g._ VSCode, RStudio, NVim), its version, and the operating system you're running (_e.g., MacOS Ventura 13.4, Windows 11, Linux Debian 11, _etc._).
55+
placeholder: |
56+
- IDE: RStudio 2023.06.2+561
57+
- OS: MacOS Ventura 13.4
58+
59+
- type: textarea
60+
attributes:
61+
label: Quarto check output
62+
description: |
63+
Please provide the output of `quarto check` so we know which version of quarto and its dependencies you're running.
64+
placeholder: |
65+
```bash
66+
quarto check
67+
```
68+
69+
- type: markdown
70+
attributes:
71+
value: "_Thanks for submitting this bug report!_"

.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: true
+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Feature request
2+
description: Ask for a feature to be added
3+
labels: ['t: feature-request']
4+
title: "[Feature]: "
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
First, please check [`quarto-pyodide` Issue Tracker](https://github.com/coatless-quarto/pyodide/issues?q=is%3Aissue+) to see if your feature request has already been discussed.
10+
If it has, please consider adding a comment to the existing issue instead of creating a new one.
11+
12+
After checking, if you are not sure if your feature request has already been discussed, please create a new issue.
13+
We look forward to hearing from you.
14+
15+
Finally, try to describe the best you can what you want to achieve and why you think it is important.
16+
This will help us to understand your request and prioritise it.
17+
18+
_Thank you for opening this feature request!_
19+
- type: textarea
20+
attributes:
21+
label: Feature Description
22+
description: Please discuss your feature request here!
23+
validations:
24+
required: true
25+
- type: markdown
26+
attributes:
27+
value: |
28+
_Thank you for opening this feature request!_

.github/ISSUE_TEMPLATE/question.yml

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
name: Question
2+
description: Ask a question
3+
labels: ['t: question', 's: question-needs-answer']
4+
title: "[Q&A]: "
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
**Before You Begin:**
10+
1. Check the [**quarto-pyodide Issue Tracker**](https://github.com/coatless-quarto-pyodide/issues?q=is%3Aissue+) to ensure your question hasn't already been addressed.
11+
12+
2. If you're uncertain, feel free to create a new issue; we appreciate your engagement.
13+
14+
**Creating a New Issue:**
15+
16+
If you're creating a new issue, please provide the following information:
17+
18+
1. **Description**: Clearly state your question or problem.
19+
20+
2. **Goal**: Explain what you're trying to achieve or the challenge you're facing.
21+
22+
3. **Significance**: Share why this issue matters to you or the project.
23+
24+
4. **Additional Information**: Include any relevant context, such as your system setup, actions taken so far, and any potential solutions you've considered.
25+
26+
**Thank you for reaching out!**
27+
- type: textarea
28+
attributes:
29+
label: What's your question?
30+
description: |
31+
You can include pyodide-powered Quarto document code with your question by using:
32+
33+
````qmd
34+
---
35+
title: "Hello quarto-pyodide!"
36+
format: html
37+
filters:
38+
- pyodide
39+
---
40+
41+
```{pyodide-python}
42+
1 + 1
43+
```
44+
````
45+
46+
validations:
47+
required: true
48+
- type: markdown
49+
attributes:
50+
value: |
51+
_Thank you for opening this issue to ask a question!_

0 commit comments

Comments
 (0)