🔧 Add template for GitHub Discussion questions and update issues template (#544)

2024-11-21 22:58:22 +00:00 · 2023-01-30 11:49:56 +01:00 · 2023-01-30 11:49:56 +01:00 · 624a2142bf
commit 624a2142bf
parent 7b3148c0b4
2 changed files with 170 additions and 10 deletions
--- a/.github/DISCUSSION_TEMPLATE/questions.yml
+++ b/.github/DISCUSSION_TEMPLATE/questions.yml
@ -0,0 +1,160 @@
+labels: [question]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for your interest in SQLModel! 🚀
+
+        Please follow these instructions, fill every question, and do every step. 🙏
+
+        I'm asking this because answering questions and solving problems in GitHub is what consumes most of the time.
+
+        I end up not being able to add new features, fix bugs, review pull requests, etc. as fast as I wish because I have to spend too much time handling questions.
+
+        All that, on top of all the incredible help provided by a bunch of community members that give a lot of their time to come here and help others.
+
+        If more SQLModel users came to help others like them just a little bit more, it would be much less effort for them (and you and me 😅).
+
+        By asking questions in a structured way (following this) it will be much easier to help you.
+
+        And there's a high chance that you will find the solution along the way and you won't even have to submit it and wait for an answer. 😎
+
+        As there are too many questions, I'll have to discard and close the incomplete ones. That will allow me (and others) to focus on helping people like you that follow the whole process and help us help you. 🤓
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: First Check
+      description: Please confirm and check all the following options.
+      options:
+        - label: I added a very descriptive title here.
+          required: true
+        - label: I used the GitHub search to find a similar question and didn't find it.
+          required: true
+        - label: I searched the SQLModel documentation, with the integrated search.
+          required: true
+        - label: I already searched in Google "How to X in SQLModel" and didn't find any information.
+          required: true
+        - label: I already read and followed all the tutorial in the docs and didn't find an answer.
+          required: true
+        - label: I already checked if it is not related to SQLModel but to [Pydantic](https://github.com/samuelcolvin/pydantic).
+          required: true
+        - label: I already checked if it is not related to SQLModel but to [SQLAlchemy](https://github.com/sqlalchemy/sqlalchemy).
+          required: true
+  - type: checkboxes
+    id: help
+    attributes:
+      label: Commit to Help
+      description: |
+        After submitting this, I commit to one of:
+
+          * Read open issues with questions until I find 2 issues where I can help someone and add a comment to help there.
+          * I already hit the "watch" button in this repository to receive notifications and I commit to help at least 2 people that ask questions in the future.
+          * Review one Pull Request by downloading the code and following all the review process](https://sqlmodel.tiangolo.com/help/#review-pull-requests).
+
+      options:
+        - label: I commit to help with one of those options 👆
+          required: true
+  - type: textarea
+    id: example
+    attributes:
+      label: Example Code
+      description: |
+        Please add a self-contained, [minimal, reproducible, example](https://stackoverflow.com/help/minimal-reproducible-example) with your use case.
+
+        If I (or someone) can copy it, run it, and see it right away, there's a much higher chance I (or someone) will be able to help you.
+
+      placeholder: |
+        from typing import Optional
+
+        from sqlmodel import Field, Session, SQLModel, create_engine
+
+
+        class Hero(SQLModel, table=True):
+            id: Optional[int] = Field(default=None, primary_key=True)
+            name: str
+            secret_name: str
+            age: Optional[int] = None
+
+
+        hero_1 = Hero(name="Deadpond", secret_name="Dive Wilson")
+
+        engine = create_engine("sqlite:///database.db")
+
+
+        SQLModel.metadata.create_all(engine)
+
+        with Session(engine) as session:
+            session.add(hero_1)
+            session.commit()
+            session.refresh(hero_1)
+            print(hero_1)
+      render: python
+    validations:
+      required: true
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: |
+        What is the problem, question, or error?
+
+        Write a short description telling me what you are doing, what you expect to happen, and what is currently happening.
+      placeholder: |
+        * Create a Hero model.
+        * Create a Hero instance.
+        * Save it to a SQLite database.
+        * Check the data with DB Browser for SQLite.
+        * There's only one hero there, but I expected it to include many others recruited by the first one.
+    validations:
+      required: true
+  - type: dropdown
+    id: os
+    attributes:
+      label: Operating System
+      description: What operating system are you on?
+      multiple: true
+      options:
+        - Linux
+        - Windows
+        - macOS
+        - Other
+    validations:
+      required: true
+  - type: textarea
+    id: os-details
+    attributes:
+      label: Operating System Details
+      description: You can add more details about your operating system here, in particular if you chose "Other".
+  - type: input
+    id: sqlmodel-version
+    attributes:
+      label: SQLModel Version
+      description: |
+        What SQLModel version are you using?
+
+        You can find the SQLModel version with:
+
+        ```bash
+        python -c "import sqlmodel; print(sqlmodel.__version__)"
+        ```
+    validations:
+      required: true
+  - type: input
+    id: python-version
+    attributes:
+      label: Python Version
+      description: |
+        What Python version are you using?
+
+        You can find the Python version with:
+
+        ```bash
+        python --version
+        ```
+    validations:
+      required: true
+  - type: textarea
+    id: context
+    attributes:
+      label: Additional Context
+      description: Add any additional context information or screenshots you think are useful.
--- a/.github/ISSUE_TEMPLATE/question.yml
+++ b/.github/ISSUE_TEMPLATE/question.yml
@ -8,29 +8,29 @@ body:
        Thanks for your interest in SQLModel! 🚀

        Please follow these instructions, fill every question, and do every step. 🙏
-        
-        I'm asking this because answering questions and solving problems in GitHub issues is what consumes most of the time.
-        
-        I end up not being able to add new features, fix bugs, review pull requests, etc. as fast as I wish because I have to spend too much time handling issues.
+
+        I'm asking this because answering questions and solving problems in GitHub is what consumes most of the time.
+
+        I end up not being able to add new features, fix bugs, review pull requests, etc. as fast as I wish because I have to spend too much time handling questions.

        All that, on top of all the incredible help provided by a bunch of community members that give a lot of their time to come here and help others.

        If more SQLModel users came to help others like them just a little bit more, it would be much less effort for them (and you and me 😅).

        By asking questions in a structured way (following this) it will be much easier to help you.
-        
+
        And there's a high chance that you will find the solution along the way and you won't even have to submit it and wait for an answer. 😎

-        As there are too many issues with questions, I'll have to close the incomplete ones. That will allow me (and others) to focus on helping people like you that follow the whole process and help us help you. 🤓
+        As there are too many questions, I'll have to discard and close the incomplete ones. That will allow me (and others) to focus on helping people like you that follow the whole process and help us help you. 🤓
  - type: checkboxes
    id: checks
    attributes:
      label: First Check
      description: Please confirm and check all the following options.
      options:
-        - label: I added a very descriptive title to this issue.
+        - label: I added a very descriptive title here.
          required: true
-        - label: I used the GitHub search to find a similar issue and didn't find it.
+        - label: I used the GitHub search to find a similar question and didn't find it.
          required: true
        - label: I searched the SQLModel documentation, with the integrated search.
          required: true
@ -48,10 +48,10 @@ body:
      label: Commit to Help
      description: |
        After submitting this, I commit to one of:
-          
+
          * Read open issues with questions until I find 2 issues where I can help someone and add a comment to help there.
          * I already hit the "watch" button in this repository to receive notifications and I commit to help at least 2 people that ask questions in the future.
-          * Implement a Pull Request for a confirmed bug.
+          * Review one Pull Request by downloading the code and following all the review process](https://sqlmodel.tiangolo.com/help/#review-pull-requests).

      options:
        - label: I commit to help with one of those options 👆