summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
author0dminnimda <0dminnimda@gmail.com>2023-03-07 09:57:25 +0300
committerGitHub <noreply@github.com>2023-03-07 07:57:25 +0100
commit34cb80b335d0e0a7913a80310ee33e21ec1d10c9 (patch)
treea10a51c4fec9036b09a95d459a2b10b875566a52 /.github
parenta12638ffd2dd2c3b336d2069eac68c95fa224d86 (diff)
downloadcython-34cb80b335d0e0a7913a80310ee33e21ec1d10c9.tar.gz
[ENH] Improve GH issue templates (GH-5223)
* Use separate fields for environment information in bug reports. * Order the templates explicitly. * Add a reference to the mailing list.
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/1_bug_report.yml (renamed from .github/ISSUE_TEMPLATE/bug_report.yml)26
-rw-r--r--.github/ISSUE_TEMPLATE/2_feature_request.yml (renamed from .github/ISSUE_TEMPLATE/feature_request.yml)0
-rw-r--r--.github/ISSUE_TEMPLATE/3_blank_issue.yml21
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml6
-rw-r--r--.github/ISSUE_TEMPLATE/other.md20
5 files changed, 41 insertions, 32 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/1_bug_report.yml
index 1c2f8aa83..f1828b030 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.yml
+++ b/.github/ISSUE_TEMPLATE/1_bug_report.yml
@@ -36,17 +36,25 @@ body:
attributes:
label: "Expected behaviour"
description: "A clear and concise description of what you expected to happen."
- - type: textarea
- id: environment
+ - type: markdown
attributes:
- label: Environment
- description: "please complete the following information"
value: |
- OS: [e.g. Linux, Windows, macOS]
- Python version [e.g. 3.10.2]
- Cython version [e.g. 3.0.0a11]
- validations:
- required: true
+ **Environment** - please complete the following information:
+ - type: input
+ id: environment_os
+ attributes:
+ label: "OS"
+ placeholder: "e.g. Linux, Windows, macOS"
+ - type: input
+ id: environment_python_v
+ attributes:
+ label: "Python version"
+ placeholder: "e.g. 3.10.2"
+ - type: input
+ id: environment_cython_v
+ attributes:
+ label: "Cython version"
+ placeholder: "e.g. 3.0.0a11"
- type: textarea
id: context
attributes:
diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/2_feature_request.yml
index 3d46fe3bc..3d46fe3bc 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.yml
+++ b/.github/ISSUE_TEMPLATE/2_feature_request.yml
diff --git a/.github/ISSUE_TEMPLATE/3_blank_issue.yml b/.github/ISSUE_TEMPLATE/3_blank_issue.yml
new file mode 100644
index 000000000..2b278de5e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/3_blank_issue.yml
@@ -0,0 +1,21 @@
+name: Blank Issue
+description: Not a Bug or a Feature Request. DO NOT post support questions here, see the "I NEED HELP" section
+body:
+ - type: markdown
+ attributes:
+ value: |
+ **PLEASE READ THIS FIRST:**
+ - DO NOT use the bug and feature tracker for general questions and support requests.
+ Use the [`cython-users`](https://groups.google.com/g/cython-users) mailing list instead.
+ It has a wider audience, so you get more and better answers.
+ - Did you search for SIMILAR ISSUES already?
+ Please do, it helps to save us precious time that we otherwise could not invest into development.
+ - Did you try the LATEST MASTER BRANCH or pre-release?
+ It might already have what you want to report.
+ Specifically, the legacy stable 0.29.x release series receives only important low-risk bug fixes.
+ Also see the [Changelog](https://github.com/cython/cython/blob/master/CHANGES.rst) regarding recent changes
+ - type: textarea
+ attributes:
+ label: "Describe your issue"
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 40a53efc9..67c3c671c 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,5 +1,5 @@
-blank_issues_enabled: true
+blank_issues_enabled: false
contact_links:
- - name: Cython-users mailing list
+ - name: I NEED HELP or I have a question/comment
url: https://groups.google.com/g/cython-users
- about: Please ask and answer support questions here instead of on github.
+ about: The Cython-users mailing list is a place to ask and answer support questions.
diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md
deleted file mode 100644
index 95aa5153e..000000000
--- a/.github/ISSUE_TEMPLATE/other.md
+++ /dev/null
@@ -1,20 +0,0 @@
----
-name: Other
-about: Anything that does not qualify as either "bug" or "feature request". DO NOT post support requests here.
-title: ""
-labels: ''
-assignees: ''
-
----
-
-<!--
-**Note:**
-- DO NOT use the bug and feature tracker for general questions and support requests.
- Use the `cython-users` mailing list instead.
- It has a wider audience, so you get more and better answers.
-- Did you search for similar issues already?
- Please do, it helps to save us precious time that we otherwise could not invest into development.
-- Did you try the latest master branch or pre-release?
- It might already have what you want to report.
- Also see the [Changelog](https://github.com/cython/cython/blob/master/CHANGES.rst) regarding recent changes.
--->