diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 0000000..76c5710 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -0,0 +1,71 @@ +name: Bug report +description: Report an error or unexpected behavior +labels: ['t: bug', 's: triage-needed'] +title: "[Bug]: " +body: + - type: markdown + attributes: + value: | + Welcome to the quarto-pyodide Extension GitHub repository! + + 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. + + Thank you in advance for your feedback. + + - type: textarea + attributes: + label: Bug description + description: Description of the bug and why you think its a bug. + placeholder: Please describe the bug here. + + - type: textarea + attributes: + label: Steps to reproduce + description: | + Tell us how to reproduce this bug. + + Please include a minimal, fully reproducible example as a self-contained Quarto document or a link to a Git repository. + placeholder: | + You can share a Quarto document using the following syntax, _i.e._, using more backticks than you have in your document (usually four ` ```` `). + + ````qmd + --- + title: "Reproducible pyodide powered Quarto Document" + format: html + filter: + - pyodide + --- + + This is a reproducible Quarto document using `format: html` with + the `pyodide` filter active. It contains a pyodide code cell that + should create a plot using the cars data. + + ```{pyodide-python} + [x**2 for x in range(0, 5)] + ``` + + The end. + ```` + + - type: textarea + attributes: + label: Your environment + description: | + 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._). + placeholder: | + - IDE: RStudio 2023.06.2+561 + - OS: MacOS Ventura 13.4 + + - type: textarea + attributes: + label: Quarto check output + description: | + Please provide the output of `quarto check` so we know which version of quarto and its dependencies you're running. + placeholder: | + ```bash + quarto check + ``` + + - type: markdown + attributes: + value: "_Thanks for submitting this bug report!_" \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..a49eab2 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml new file mode 100644 index 0000000..778768c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request.yml @@ -0,0 +1,28 @@ +name: Feature request +description: Ask for a feature to be added +labels: ['t: feature-request'] +title: "[Feature]: " +body: + - type: markdown + attributes: + value: | + 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. + If it has, please consider adding a comment to the existing issue instead of creating a new one. + + After checking, if you are not sure if your feature request has already been discussed, please create a new issue. + We look forward to hearing from you. + + Finally, try to describe the best you can what you want to achieve and why you think it is important. + This will help us to understand your request and prioritise it. + + _Thank you for opening this feature request!_ + - type: textarea + attributes: + label: Feature Description + description: Please discuss your feature request here! + validations: + required: true + - type: markdown + attributes: + value: | + _Thank you for opening this feature request!_ \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..8df6cc5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,51 @@ +name: Question +description: Ask a question +labels: ['t: question', 's: question-needs-answer'] +title: "[Q&A]: " +body: + - type: markdown + attributes: + value: | + **Before You Begin:** + 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. + + 2. If you're uncertain, feel free to create a new issue; we appreciate your engagement. + + **Creating a New Issue:** + + If you're creating a new issue, please provide the following information: + + 1. **Description**: Clearly state your question or problem. + + 2. **Goal**: Explain what you're trying to achieve or the challenge you're facing. + + 3. **Significance**: Share why this issue matters to you or the project. + + 4. **Additional Information**: Include any relevant context, such as your system setup, actions taken so far, and any potential solutions you've considered. + + **Thank you for reaching out!** + - type: textarea + attributes: + label: What's your question? + description: | + You can include pyodide-powered Quarto document code with your question by using: + + ````qmd + --- + title: "Hello quarto-pyodide!" + format: html + filters: + - pyodide + --- + + ```{pyodide-python} + 1 + 1 + ``` + ```` + + validations: + required: true + - type: markdown + attributes: + value: | + _Thank you for opening this issue to ask a question!_ \ No newline at end of file