docs: update GH templates (#1324)

LordOfPolls · web-flow · commit f6c2df7a6136 · 2023-04-07T20:33:34.000+01:00
* docs: update pr template

* docs: update bug report template

* docs: update feature request
diff --git a/.github/ISSUE_TEMPLATE/report-bug.yml b/.github/ISSUE_TEMPLATE/report-bug.yml
@@ -1,90 +1,73 @@
-name: Report Bug
-description: Create an Issue to report a bug with/about the library.
-title: "[BUG] "
-labels: ["bug"]
-assignees:
-  - DeltaXWizard
-  - EdVraz
-  - Astrea49
-  - Toricane
-  - Catalyst4222
-  - Damego
+name: Bug Report
+description: Report broken or incorrect behavior.
+labels: ["Bug::Library"]
+title: "[BUG] Your Title Here"
+
 body:
   - type: markdown
     attributes:
-      value: |
+      value: >
         Thank you for taking the time to fill out this bug report!
         We rely on users to tell us things that we might not find on our own,
         and your help is greatly valued by the team and others contributing.
-  - type: textarea
-    id: process
+        If you want real-time support, consider joining our [Discord](https://discord.gg/interactions) instead.
+
+  - type: input
     attributes:
-      label: Describe the bug.
-      description: Please give us an in-depth description of the bug you are having.
-      placeholder: When trying to use feature X, I was unable to make task Y work.
+      label: Library Version
+      description: Which version of the library you are currently running.
     validations:
       required: true
+
   - type: textarea
-    id: steps
     attributes:
-      label: List the steps.
-      description: Please give us a step-by-step process of how you were able to produce this.
-      placeholder: |
-        1. Import the module in Python.
-        2. Create a client variable for the library.
-        3. Try creating a slash command.
-        4. See the traceback error given in the terminal or logger file.
+      label: Describe the Bug
+      description: A simple summary of your bug report
     validations:
       required: true
+
   - type: textarea
-    id: expectation
     attributes:
-      label: What you expected.
-      description: Please tell us what you expect for this to do when it ran.
-      placeholder: When I create a slash command, the command should be created and functional.
+      label: Steps to Reproduce
+      description: Please give us a step-by-step process of how you were able to produce this.
     validations:
       required: true
+
   - type: textarea
-    id: result
     attributes:
-      label: What you saw.
-      description: Please tell us what you found when you actually ran this.
-      placeholder: Instead, I received this traceback error given from my Python terminal.
-      value: |
-        Instead, I received this traceback error given from my Python terminal:
-        ```
-        Traceback (most recent call last):
-          File "A:\Amogus\Python\interactions-bot\main.py", line 6
-            raise SussyBaka("your code doesn't work, silly!")
-                  ^
-
-        SussyBaka: your code doesn't work, silly!
-        ```
+      label: Expected Results
+      description: A clear and concise description of what you expected to happen.
     validations:
       required: true
-  - type: dropdown
-    id: version
+
+  - type: textarea
     attributes:
-      label: What version of the library did you use?
-      multiple: false
-      options:
-        - release
-        - stable
-        - unstable
-    validations:
-      required: true
-  - type: input
-    id: version-specific
+      label: Minimal Reproducible Code
+      description: A short snippet of code that showcases the bug.
+      render: python
+
+  - type: textarea
     attributes:
-      label: Version specification
-      description: "If you're using a pre-release or release candidate, please specify which one."
+      label: Traceback
+      description: Was there a traceback? If so, please provide it.
     validations:
       required: false
+
   - type: checkboxes
-    id: accept
     attributes:
-      label: Code of Conduct
-      description: By submitting this Issue, you agree to follow our [contribution requirements.](https://github.com/interactions-py/library/blob/unstable/CONTRIBUTING.rst)
+      label: Checklist
+      description: Let's make sure you've properly done due diligence when reporting this issue!
       options:
-        - label: I agree to follow the contribution requirements.
+        - label: I have searched the open issues for duplicates.
           required: true
+        - label: I have shown the entire traceback, if possible.
+          required: true
+        - label: I have removed my token from display, if visible.
+          required: true
+        - label: I have attempted to debug this myself, and I believe this issue is with the library
+          required: true
+
+  - type: textarea
+    attributes:
+      label: Additional Information
+      description: Any other information about the problem.
diff --git a/.github/ISSUE_TEMPLATE/request-feature.yml b/.github/ISSUE_TEMPLATE/request-feature.yml
@@ -1,29 +1,39 @@
-name: Request a new feature
-description: Create an Issue to suggest or propose implementing something(s).
-title: "[REQUEST] "
-labels: ["documentation", "enhancement"]
-assignees:
-  - DeltaXWizard
-  - EdVraz
-  - Astrea49
-  - Toricane
-  - Catalyst4222
-  - Damego
+name: Feature Request
+description: Request new functionality.
+title: "[FEAT] Your Title Here"
+
 body:
   - type: markdown
     attributes:
       value: |
         Thank you for taking the time to fill out this feature request!
         We rely on users to tell us things that we might not find on our own,
         and your help is greatly valued by the team and others contributing.
+
   - type: textarea
-    id: process
     attributes:
-      label: Describe the feature.
-      description: Please give us an in-depth description of the feature you wish to see.
-      placeholder: I am not a fan of doing X for Y, so I would like...
+      label: Problem Description
+      description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
     validations:
       required: true
+
+  - type: textarea
+    attributes:
+      label: Proposed Solution
+      description: A clear and concise description of what you want to happen.
+    validations:
+      required: true
+
+  - type: textarea
+    attributes:
+      label: Alternatives Considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+
+  - type: textarea
+    attributes:
+      label: Additional Information
+      description: Any additional information that may help clarify your request.
+
   - type: checkboxes
     id: accept
     attributes:
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,26 +1,40 @@
-## About
+## Pull Request Type
+<!-- Check the appropriate option -->
 
-This pull request is about (X), which does (Y).
+- [ ] Feature addition
+- [ ] Bugfix
+- [ ] Documentation update
+- [ ] Code refactor
+- [ ] Tests improvement
+- [ ] CI/CD pipeline enhancement
+- [ ] Other: [Replace with a description]
 
-## Checklist
+## Description
+<!-- Provide a clear and concise description of the purpose of this PR and why it should be merged -->
+<!-- If your code adds or changes features, a usage example would be helpful -->
+
+
+## Changes
+<!-- List the changes you have made in a bullet-point format -->
 
-- [ ] The ``pre-commit`` code linter has been run over all edited files to ensure the code is linted.
-- [ ] I've ensured the change(s) work on `3.8.6` and higher.
-- [ ] I have added the `versionadded`, `versionchanged` and `deprecated` to any new or changed user-facing function I committed.
-<!-- If you are unsure what the next version is, feel free to ask in #unstable at https://discord.gg/interactions -->
 
-### Pull-Request specification
+## Related Issues
+<!-- If this PR is related to any open issues, please mention them using "#ISSUENUMBER" -->
 
-I've made this pull request: (check all that apply)
-  - [ ] For the documentation
-  - [ ] To add a new feature
-  - [ ] As a general enhancement
-  - [ ] As a refactor of the library/the library's code
-  - [ ] To fix an existing bug
-  - [ ] To resolve #ISSUENUMBER
 
+## Test Scenarios
+<!-- Provide clear instructions on how to test your changes, where applicable - if no tests are required, explain why -->
 
-This is:
-  - [ ] A breaking change
 
-<!--- Expand this when more comes up--->
+## Python Compatibility
+<!-- Testing 3.11 is not strictly required, but it would be nice if you could confirm that it works. -->
+- [ ] I've ensured my code works on Python `3.10.x`
+- [ ] I've ensured my code works on Python `3.11.x`
+
+
+## Checklist
+<!-- If you have not completed all of the following, there is a good chance your PR will not be merged. -->
+- [ ] I've run the `pre-commit` code linter over all edited files
+- [ ] I've tested my changes on supported Python versions
+- [ ] I've added tests for my code, if applicable
+- [ ] I've updated / added  documentation, where applicable
