From 702597afda6e137989a412f0d6872c5f859734d2 Mon Sep 17 00:00:00 2001 From: mejrs Date: Thu, 21 Oct 2021 04:35:29 +0200 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/blank_issue.md | 4 ++ .github/ISSUE_TEMPLATE/bug_report.yml | 81 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 11 +++ .github/ISSUE_TEMPLATE/feature_request.md | 14 ++++ .github/issue_template.md | 18 ----- 5 files changed, 110 insertions(+), 18 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/blank_issue.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md delete mode 100644 .github/issue_template.md diff --git a/.github/ISSUE_TEMPLATE/blank_issue.md b/.github/ISSUE_TEMPLATE/blank_issue.md new file mode 100644 index 00000000..039c2da5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/blank_issue.md @@ -0,0 +1,4 @@ +--- +name: 📝 Blank Issue +about: Create a blank issue. +--- \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..40fb4d12 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,81 @@ +name: 🐛 Bug Report +description: Create a bug report +labels: [bug] +body: + - type: markdown + attributes: + value: | + Thank you for taking the time to fill out this bug report! + Please fill out the form below... + - type: textarea + id: description + attributes: + label: Bug Description + description: Please provide a clear and concise description of what the bug is. + placeholder: The bug is... + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: Steps to Reproduce + description: Provide steps to reproduce this bug. + placeholder: | + 1. + 2. + 3. + validations: + required: true + - type: textarea + id: debug + attributes: + label: Backtrace + description: If your bug produces a backtrace, please include it here. + render: shell + + - type: input + id: os_version + attributes: + label: Your operating system and version + validations: + required: true + - type: input + id: py_version + attributes: + label: Your Python version (`python --version`) + placeholder: ex. Python 3.10.0 + validations: + required: true + - type: input + id: rust_version + attributes: + label: Your Rust version (`rustc --version`) + placeholder: ex. rustc 1.55.0 (c8dfcfe04 2021-09-06) + validations: + required: true + - type: input + id: pyo3_version + attributes: + label: Your PyO3 version + placeholder: ex. 0.14.0 + validations: + required: true + - type: textarea + id: install_method + attributes: + label: How did you install python? Did you use a virtualenv? + placeholder: | + apt + pyenv + pacman + brew + python.org installer + microsoft store + etc... + validations: + required: true + - type: textarea + id: additional-info + attributes: + label: Additional Info + description: Any additional info that you think might be useful or relevant to this bug \ 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 00000000..4d31afe4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,11 @@ +blank_issues_enabled: true +contact_links: + - name: ❓ Question + url: https://github.com/PyO3/pyo3/discussions + about: Ask and answer questions about PyO3 on Discussions + - name: 🔧 Troubleshooting + url: https://github.com/PyO3/pyo3/discussions + about: For troubleshooting help, see the Discussions + - name: 👋 Chat + url: https://gitter.im/PyO3/Lobby + about: Engage with PyO3's users and developers on Gitter \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 00000000..3cac000b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: 💡 Feature request +about: Suggest an idea for this project +labels: [enhancement] +--- + + \ No newline at end of file diff --git a/.github/issue_template.md b/.github/issue_template.md deleted file mode 100644 index 027e0842..00000000 --- a/.github/issue_template.md +++ /dev/null @@ -1,18 +0,0 @@ -## 🐛 Bug Reports - -When reporting a bug, please provide the following information. If this is not a bug report you can just discard this template. - -### 🌍 Environment - - - Your operating system and version: - - Your python version: - - How did you install python (e.g. apt or pyenv)? Did you use a virtualenv?: - - Your Rust version (`rustc --version`): - - Your PyO3 version: - - Have you tried using latest PyO3 main (replace `version = "0.x.y"` with `git = "https://github.com/PyO3/pyo3")?`: - -### 💥 Reproducing - -Please provide a [minimal working example](https://stackoverflow.com/help/mcve). This means both the Rust code and the Python. - -Please also write what exact flags are required to reproduce your results.