Merge pull request #34 from abiriadev/improve-issue-templates

Improve issue & pr templates

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,120 @@
+name: Bug report
+description: |
+  Something is broken and you have a reliable reproduction? Let us know here.
+assignees:
+  - abiriadev
+labels:
+  - bug
+title: "[Bug]: "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to report a bug!
+  - type: checkboxes
+    attributes:
+      label: Prerequisites
+      description: |
+        Have you searched for existing issues?
+        
+        Please ensure your issue hasn't been reported yet.
+      options:
+        - label: I've checked for existing issues
+          required: true
+    validations:
+      required: true
+  - type: markdown
+    attributes:
+      value: |
+        ## Issue Overview
+  - type: textarea
+    attributes:
+      label: Bug Description
+      description: |
+        What exactly happened?
+        
+        Please provide a detailed description of the issue.
+
+        _If multiple independent bugs occurred simultaneously, please report each issue separately._
+      value: |
+        <!--
+        Describe the bug you encountered.
+
+        Use screenshots or GIFs if possible, as they are intuitive ways to convey the problem.
+        -->
+        
+        <!--
+        ```ts
+        Copy and paste any relevant error messages, log output, or other pertinent information.
+
+        Use multiple code blocks for multiple messages.
+        ```
+        -->
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Expected Behavior
+      description: |
+        What was the expected behavior?
+        
+        Describe the expected outcome or your suggestion.
+
+        _You can skip this if it's obvious that the issue is an error._
+      value: |
+        This is an error, and should not occur.
+  - type: markdown
+    attributes:
+      value: |
+        ## Environment Details & Steps to Reproduce
+  - type: input
+    attributes:
+      label: Version Information
+      description: |
+        Which version of Seia/Node.js are you using?
+        
+        Type the following command in your terminal and paste the result:
+        
+        ```sh
+        seia --version
+        ```
+      placeholder: |
+        seia.js/0.1.3 linux-x64 node-v22.2.0
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: Package Manager
+      description: |
+        Which package manager and version are you using?
+        
+        Type the following commands in your terminal:
+
+        ```sh
+        npm --version
+        yarn --version
+        pnpm --version
+        ```
+
+        Have you tested with other package managers? Is this issue specific to a package manager? You can provide multiple managers & versions in this case.
+        
+        _Note: Some issues only arise with Yarn Berry._
+      placeholder: [email protected]
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: Reproduction Steps
+      description: |
+        How can we reproduce the issue?
+        
+        Provide detailed steps or a reproducible scenario to help us understand and replicate the problem.
+
+        If you have a reproduction repository, please provide its link.
+
+        If you have a dockerfile, that's also great. provide it too.
+      placeholder: |
+        1. clone the reproduction repository.
+        2. install dependencies.
+        3. run some commands.
+        4. open the browser and see the result.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,8 @@
+blank_issues_enabled: true
+contact_links:
+  - name: GitHub Discussions
+    url: https://github.com/abiriadev/seia/discussions
+    about: Do you have a question? You can start a new discussion here!
+  - name: Discord Community
+    url: https://discord.gg/xuSH6QuQwG
+    about: If you prefer Discord, join the official server and ask there!

.github/ISSUE_TEMPLATE/doc.yml

@@ -0,0 +1,49 @@
+name: Update docs
+description: |
+  Have you found a mistake in the documentation or have an idea to improve it? Share your suggestions for better documentation here.
+assignees:
+  - abiriadev
+labels:
+  - documentation
+title: "[Doc]: "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to improve our doc!
+  - type: checkboxes
+    attributes:
+      label: Prerequisites
+      description: |
+        Have you searched for existing issues?
+        
+        Please ensure your issue hasn't been reported yet.
+      options:
+        - label: I've checked for existing issues
+          required: true
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: Type
+      description: A
+      multiple: true
+      options:
+        - Typo
+        - Undocumented
+        - Outdated
+        - n/a
+    validations:
+      require: true
+  - type: textarea
+    attributes:
+      label: Description
+      description: |
+        Describe which part of the documentation is incorrect and how you would like to improve it.
+
+        Please link to the specific section of the documentation you are referring to, including an anchor if possible.
+
+        Alternatively, you can provide a permalink to the source.
+      value: |
+    validations:
+      required: true

.github/ISSUE_TEMPLATE/enhance.yml

@@ -0,0 +1,38 @@
+name: Enhancement Suggestion
+description: |
+  Have an idea to improve the project? Share your suggestions for new features or improvements here.
+assignees:
+  - abiriadev
+labels:
+  - enhancement
+title: "[Feat]: "
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Thanks for taking the time to help us improve!
+  - type: textarea
+    attributes:
+      label: Problem
+      description: |
+        Describe the problem or limitation you are experiencing.
+        
+        What issue or need is driving your suggestion?
+  - type: textarea
+    attributes:
+      label: Suggestion
+      description: |
+        Provide your suggestion for how to solve the problem or enhance the project.
+        
+        Include details on the proposed solution or improvement.
+    validations:
+      required: true
+  - type: checkboxes
+    attributes:
+      label: Willingness to Contribute
+      description: |
+        Are you willing to actively contribute to implementing this enhancement?
+      options:
+        - label: I'm willing to actively contribute to it
+    validations:
+      required: true

.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

@@ -0,0 +1,26 @@
+<!-- See https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/using-keywords-in-issues-and-pull-requests#linking-a-pull-request-to-an-issue -->
+- Resolves #
+
+<!-- Remove if not. -->
+**:warning: This is a breaking change.**
+
+### Description
+<!--
+Please provide a brief summary of the changes made in this PR:
+- What is the purpose of this PR?
+- Which issues does this PR address? (Include issue numbers if applicable)
+
+If your changes make visual differences, consider adding screenshots to show the changes.
+-->
+
+### Changes
+<!--
+List the notable changes made in this PR.
+-->
+
+#### Documentation
+<!--
+List necessary documentation changes here.
+
+Make sure no documents are left outdated.
+-->