Merge pull request #10406 from pradyunsg/new-issue-workflow

Tweaks issue templates

Author: pradyunsg

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -3,6 +3,17 @@ description: Something is not working correctly.
 labels: "S: needs triage, type: bug"
 
 body:
+  - type: markdown
+    attributes:
+      value: >-
+        Hi there!
+
+        We'd appreciate it if you could search on pip's existing issues prior to filing
+        a bug report.
+
+        We get a lot of duplicate tickets and have limited maintainer capacity to triage
+        them. Thanks!
+
   - type: textarea
     attributes:
       label: Description
@@ -37,7 +48,7 @@ body:
     attributes:
       label: How to Reproduce
       description: Please provide steps to reproduce this bug.
-      value: |
+      placeholder: |
         1. Get package from '...'
         2. Then run '...'
         3. An error occurs.
@@ -49,7 +60,14 @@ body:
       label: Output
       description: >-
         Provide the output of the steps above, including the commands
-        themselves and pip's output/traceback etc.
+        themselves and pip's output/traceback etc. If you're familiar with
+        Markdown, this block will have triple backticks added automatically
+        around it -- you don't have to add them.
+
+        If you want to present output from multiple commands, please present
+        that as a shell session (commands you run get prefixed with `$ `).
+        Please also ensure that the "How to reproduce" section contains matching
+        instructions for reproducing this.
       render: sh-session
 
   - type: checkboxes

.github/ISSUE_TEMPLATE/config.yml

@@ -1,11 +1,8 @@
-# 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  # default
+# Documentation for this file can be found at:
+# https://help.github.com/en/github/building-a-strong-community/configuring-issue-templates-for-your-repository
+
+blank_issues_enabled: false
 contact_links:
-- name: 💬 Discourse
-  url: https://discuss.python.org/c/packaging
-  about: |
-    Please ask typical Q&A here: general ideas for Python packaging,
-    questions about structuring projects and so on
-- name: '💬 IRC: #pypa'
-  url: https://kiwiirc.com/nextclient/#ircs://irc.libera.chat:+6697/pypa
-  about: Chat with devs
+  - name: "💬 IRC: #pypa"
+    url: https://kiwiirc.com/nextclient/#ircs://irc.libera.chat:+6697/pypa
+    about: Chat with devs

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,59 @@
+name: Feature request
+description: Suggest an idea for this project
+labels: "S: needs triage, type: feature request"
+
+body:
+  - type: markdown
+    attributes:
+      value: >-
+        Hi there!
+
+        We'd appreciate it if you could search on pip's existing issues prior to filing
+        a feature request.
+
+        We get a lot of duplicate tickets and have limited maintainer capacity to triage
+        them. Thanks!
+
+  - type: textarea
+    attributes:
+      label: What's the problem this feature will solve?
+      description: >-
+        What are you trying to do, that you are unable to achieve with pip as it
+        currently stands?
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Describe the solution you'd like
+      description: >-
+        Clear and concise description of what you want to happen. Please use examples
+        of real world use cases that this would help with, and how it solves the
+        problem described above.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Alternative Solutions
+      description: >-
+        Have you tried to workaround the problem using pip or other tools? Or a
+        different approach to solving this issue? Please elaborate here.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Additional context
+      description: >-
+        Add any other context, links, etc. relevant to the feature request.
+    validations:
+      required: true
+
+  - type: checkboxes
+    attributes:
+      label: Code of Conduct
+      options:
+        - label: >-
+            I agree to follow the [PSF Code of Conduct](https://www.python.org/psf/conduct/).
+          required: true

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,38 @@
+name: Good first issue
+description: If you're a pip maintainer, use this to create a "good first issue" for new contributors.
+labels: "good first issue"
+
+body:
+  - type: textarea
+    attributes:
+      label: Description
+      description: >-
+        A clear and concise description of what the task is.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: What needs to be done
+      description: >-
+        Describe what the contributor would need to do, describing the change.
+        See https://github.com/pypa/pip/issues/7661 for example.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Guidance for potential contributors
+      description: >-
+        Usually, you don't have to modify the content here.
+      value: >-
+        This issue is a good starting point for first time contributors -- the
+        process of fixing this should be a good introduction to pip's
+        development workflow. If there is not a corresponding pull request for
+        this issue, it is up for grabs. For directions for getting set up, see our
+        [Getting Started Guide](https://pip.pypa.io/en/latest/development/getting-started/).
+        If you are working on this issue and have questions, feel free to ask
+        them here. If you've contributed code to pip before, we encourage you to
+        pick up an issue without this label.
+    validations:
+      required: true