]> git.ipfire.org Git - thirdparty/starlette.git/commitdiff
Switch to a discussion-first workflow (#1507)
authorTom Christie <tom@tomchristie.com>
Fri, 11 Feb 2022 14:47:44 +0000 (14:47 +0000)
committerGitHub <noreply@github.com>
Fri, 11 Feb 2022 14:47:44 +0000 (14:47 +0000)
.github/ISSUE_TEMPLATE/1-issue.md [new file with mode: 0644]
.github/ISSUE_TEMPLATE/bug-report.yml [deleted file]
.github/ISSUE_TEMPLATE/config.yml
.github/ISSUE_TEMPLATE/feature-request.yml [deleted file]

diff --git a/.github/ISSUE_TEMPLATE/1-issue.md b/.github/ISSUE_TEMPLATE/1-issue.md
new file mode 100644 (file)
index 0000000..4c76aeb
--- /dev/null
@@ -0,0 +1,16 @@
+---
+name: Issue
+about: Please only raise an issue if you've been advised to do so after discussion. Thanks! 🙏
+---
+
+The starting point for issues should usually be a discussion...
+
+https://github.com/encode/starlette/discussions
+
+Possible bugs may be raised as a "Potential Issue" discussion, feature requests may be raised as an "Ideas" discussion. We can then determine if the discussion needs to be escalated into an "Issue" or not.
+
+This will help us ensure that the "Issues" list properly reflects ongoing or needed work on the project.
+
+---
+
+- [ ] Initially raised as discussion #...
diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml
deleted file mode 100644 (file)
index 966090b..0000000
+++ /dev/null
@@ -1,73 +0,0 @@
-name: Bug report
-description: Report a bug to help improve this project
-body:
-  - type: checkboxes
-    id: checks
-    attributes:
-      label: Checklist
-      description: Please make sure you check all these items before submitting your bug report.
-      options:
-        - label: The bug is reproducible against the latest release or `master`.
-          required: true
-        - label: There are no similar issues or pull requests to fix it yet.
-          required: true
-  - type: textarea
-    id: describe
-    attributes:
-      label: Describe the bug
-      description: A clear and concise description of what the bug is.
-    validations:
-      required: true
-  - type: textarea
-    id: steps
-    attributes:
-      label: Steps to reproduce the bug
-      description: |
-        Provide a *minimal* example with steps to reproduce the bug locally.
-        NOTE: try to keep any external dependencies *at an absolute minimum*.
-        In other words, remove anything that doesn't make the bug go away.
-    validations:
-      required: false
-  - type: textarea
-    id: expected
-    attributes:
-      label: Expected behavior
-      description: A clear and concise description of what you expected to happen.
-    validations:
-      required: false
-  - type: textarea
-    id: actual
-    attributes:
-      label: Actual behavior
-      description: A clear and concise description of what actually happened.
-    validations:
-      required: false
-  - type: textarea
-    id: notes
-    attributes:
-      label: Debugging material
-      description: |
-        Any tracebacks, screenshots, etc. that can help understanding the problem.
-        NOTE:
-        - Please list tracebacks in full (don't truncate them).
-        - Consider using `<details>` to make tracebacks/logs collapsible if they're very large (see https://gist.github.com/ericclemmons/b146fe5da72ca1f706b2ef72a20ac39d).
-    validations:
-      required: false
-  - type: textarea
-    id: environment
-    attributes:
-      label: Environment
-      description: Describe your environment.
-      placeholder: |
-        - OS / Python / Starlette version.
-    validations:
-      required: true
-  - type: textarea
-    id: additional
-    attributes:
-      label: Additional context
-      description: |
-        Any additional information that can help understanding the problem.
-        Eg. linked issues, or a description of what you were trying to achieve.
-    validations:
-      required: false
index 2ad6e8e2700aa6665dcbfbd571c915ee2afe89c0..9c355dd90bd7c45f12187b547bc77df9e02c57d8 100644 (file)
@@ -1,7 +1,11 @@
 # Ref: https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
-blank_issues_enabled: true
+blank_issues_enabled: false
 contact_links:
-- name: Question
+- name: Discussions
+  url: https://github.com/encode/starlette/discussions
+  about: >
+    The "Discussions" forum is where you want to start. 💖
+- name: Chat
   url: https://gitter.im/encode/community
   about: >
-    Ask a question
+    Our community chat forum.
diff --git a/.github/ISSUE_TEMPLATE/feature-request.yml b/.github/ISSUE_TEMPLATE/feature-request.yml
deleted file mode 100644 (file)
index baf7910..0000000
+++ /dev/null
@@ -1,36 +0,0 @@
-name: Feature Request
-description: Suggest an idea for a feature that you would like to see in Starlette
-body:
-  - type: checkboxes
-    id: checks
-    attributes:
-      label: Checklist
-      description: Please make sure you check all these items before submitting your feature request.
-      options:
-        - label: There are no similar issues or pull requests for this yet.
-          required: true
-        - label: I discussed this idea on the [community chat](https://gitter.im/encode/community) and feedback is positive.
-          required: true
-  - type: textarea
-    id: problem
-    attributes:
-      label: Is your feature related to a problem? Please describe.
-      description: A clear and concise description of what you are trying to achieve.
-      placeholder: I want to be able to [...] but I can't because [...]
-  - type: textarea
-    id: solution
-    attributes:
-      label: Describe the solution you would like.
-      description: |
-        A clear and concise description of what you would want to happen.
-        For API changes, try to provide a code snippet of what you would like the API to look like.
-  - type: textarea
-    id: alternatives
-    attributes:
-      label: Describe alternatives you considered
-      description: Please describe any alternative solutions or features you've considered to solve your problem and why they wouldn't solve it.
-  - type: textarea
-    id: additional
-    attributes:
-      label: Additional context
-      description: Provide any additional context, screenshots, trace backs, etc. about the feature here.