summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorAlex Grönholm <alex.gronholm@nextday.fi>2022-08-17 01:38:49 +0300
committerAlex Grönholm <alex.gronholm@nextday.fi>2022-08-17 01:40:46 +0300
commit8493d1ba533df5ac66ce0065993bcae116469a5a (patch)
treeed7325679d891ed75b361f173bdadd8de013b689 /.github
parentcb56624154fa69ddafb82349a465419aacac1caa (diff)
downloadapscheduler-8493d1ba533df5ac66ce0065993bcae116469a5a.tar.gz
Switched from free-form issue templates to issue forms
A link to Discussions was also added to the configuration.
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md34
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.yaml53
-rw-r--r--.github/ISSUE_TEMPLATE/config.yml3
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md30
-rw-r--r--.github/ISSUE_TEMPLATE/features_request.yaml35
5 files changed, 91 insertions, 64 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
deleted file mode 100644
index 312ae04..0000000
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ /dev/null
@@ -1,34 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
----
-This issue tracker is **ONLY** for reporting bugs and requesting new features.
-
-Any support questions should be directed to:
-
-* [StackOverflow](https://stackoverflow.com/questions/tagged/apscheduler)
-* [Gitter](https://gitter.im/apscheduler/Lobby)
-* [Github discussions](https://github.com/agronholm/apscheduler/discussions)
-
-If you're not
-reasonably sure that you've found a bug, please ask first (preferably on
-[Gitter](https://gitter.im/apscheduler/Lobby))!
-
-:warning: Any issues filed that ignore the template will be summarily closed!
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Please provide a **minimal** reproducible example that developers can run to investigate the problem.
-You can find help for creating such an example [here](https://stackoverflow.com/help/minimal-reproducible-example).
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Additional context**
-Add any other context about the problem here.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
new file mode 100644
index 0000000..262690f
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -0,0 +1,53 @@
+name: Bug Report
+description: File a bug report
+labels: ["bug"]
+body:
+ - type: markdown
+ attributes:
+ value: >
+ If you observed a crash in the library, or saw unexpected behavior in it, report
+ your findings here. If you're not reasonably sure that it's not the intended
+ behavior, you should ask through one of the support venues listed on the
+ previous page.
+ - type: checkboxes
+ attributes:
+ label: Things to check first
+ options:
+ - label: >
+ I have checked that my issue does not already have a solution in the
+ [FAQ](https://apscheduler.readthedocs.io/en/master/faq.html)
+ required: true
+ - label: >
+ I have searched the existing issues and didn't find my bug already reported
+ there
+ required: true
+ - label: >
+ I have checked that my bug is still present in the latest release
+ required: true
+ - type: input
+ id: version
+ attributes:
+ label: Version
+ description: What version of APScheduler were you running?
+ validations:
+ required: true
+ - type: textarea
+ id: what-happened
+ attributes:
+ label: What happened?
+ description: >
+ Unless you are reporting a crash, tell us what you expected to happen instead.
+ validations:
+ required: true
+ - type: textarea
+ id: mwe
+ attributes:
+ label: How can we reproduce the bug?
+ description: >
+ In order to investigate the bug, we need to be able to reproduce it on our own.
+ Please create a
+ [minimum workable example](https://stackoverflow.com/help/minimal-reproducible-example)
+ that demonstrates the problem. List any third party libraries required for this,
+ but avoid using them unless absolutely necessary.
+ validations:
+ required: true
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
index 82f29f5..8e82bd7 100644
--- a/.github/ISSUE_TEMPLATE/config.yml
+++ b/.github/ISSUE_TEMPLATE/config.yml
@@ -3,6 +3,9 @@ contact_links:
- name: Stack Overflow
url: https://stackoverflow.com/questions/tagged/apscheduler
about: The preferred site for asking questions
+ - name: GitHub Discussions
+ url: https://github.com/agronholm/apscheduler/discussions/categories/q-a
+ about: An alternative for StackOverflow (if you don't want to register there)
- name: Support chat on Gitter
url: https://gitter.im/apscheduler/Lobby
about: Technical support chat
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
deleted file mode 100644
index 7ec1b1d..0000000
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ /dev/null
@@ -1,30 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: enhancement
-assignees: ''
-
----
-
-This issue tracker is **ONLY** for reporting bugs and requesting new features.
-
-Any support questions should be directed to:
-
-* [StackOverflow](https://stackoverflow.com/questions/tagged/apscheduler)
-* [Gitter](https://gitter.im/apscheduler/Lobby)
-* [Github discussions](https://github.com/agronholm/apscheduler/discussions)
-
-:warning: Any issues filed that ignore the template will be summarily closed!
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.
diff --git a/.github/ISSUE_TEMPLATE/features_request.yaml b/.github/ISSUE_TEMPLATE/features_request.yaml
new file mode 100644
index 0000000..45a2f73
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/features_request.yaml
@@ -0,0 +1,35 @@
+name: Feature request
+description: Suggest a new feature
+labels: ["enhancement"]
+body:
+ - type: markdown
+ attributes:
+ value: >
+ If you have thought of a new feature that would increase the usefulness of this
+ project, please use this form to send us your idea.
+ - type: checkboxes
+ attributes:
+ label: Things to check first
+ options:
+ - label: >
+ I have searched the existing issues and didn't find my feature already
+ requested there
+ required: true
+ - type: textarea
+ id: feature
+ attributes:
+ label: Feature description
+ description: >
+ Describe the feature in detail. The more specific the description you can give,
+ the easier it should be to implement this feature.
+ validations:
+ required: true
+ - type: textarea
+ id: usecase
+ attributes:
+ label: Use case
+ description: >
+ Explain why you need this feature, and why you think it would be useful to
+ others too.
+ validations:
+ required: true