Merge branch 'openimsdk:main' into main

.github/.codecov.yml

@@ -1,17 +1,3 @@
-# Copyright © 2023 OpenIM. All rights reserved.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
 coverage:
   status:
     project:
@@ -28,6 +14,7 @@ coverage:
         paths:
           - test/* # only include coverage in "test/" folder
         informational: true # Always pass check
+
       # internal: # declare a new status context "internal"
       #   paths:
       #     - internal/* # only include coverage in "internal/" folder

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,65 @@
+name: Bug Report
+title: "[BUG] "
+labels: ["bug"]
+description: "Create a detailed report to help us identify and resolve issues."
+# assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: "Thank you for taking the time to fill out the bug report. Please provide as much information as possible to help us understand and replicate the bug."
+
+  - type: input
+    id: openim-server-version
+    attributes:
+      label: OpenIM Server Version
+      description: "Please provide the version number of OpenIM Server you are using."
+      placeholder: "e.g., 3.8.0"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: operating-system
+    attributes:
+      label: Operating System and CPU Architecture
+      description: "Please select the operating system and describe the CPU architecture."
+      options:
+        - Linux (AMD)
+        - Linux (ARM)
+        - Windows (AMD)
+        - Windows (ARM)
+        - macOS (AMD)
+        - macOS (ARM)
+    validations:
+      required: true
+
+  - type: dropdown
+    id: deployment-method
+    attributes:
+      label: Deployment Method
+      description: "Please specify how OpenIM Server was deployed."
+      options:
+        - Source Code Deployment
+        - Docker Deployment
+    validations:
+      required: true
+
+  - type: textarea
+    id: bug-description-reproduction
+    attributes:
+      label: Bug Description and Steps to Reproduce
+      description: "Provide a detailed description of the bug and a step-by-step guide on how to reproduce it."
+      placeholder: "Describe the bug in detail here...\n\nSteps to reproduce the bug on the server:\n1. Start the server with specific configurations (mention any relevant config details).\n2. Make an API call to '...' endpoint with the following payload '...'.\n3. Observe the behavior and note any error messages or logs.\n4. Mention any additional setup relevant to the bug (e.g., database version, external service dependencies)."
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: "If possible, please add screenshots to help explain your problem."
+
+  - type: textarea
+    id: screenshots-link
+    attributes:
+      label: Screenshots Link
+      description: "If applicable, please provide any links to screenshots here."
+      placeholder: "Paste your screenshot URL here, e.g., http://imgur.com/example"

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,11 @@
+blank_issues_enabled: false
+contact_links:
+  # - name: "Bug Report"
+  #   description: "Report a bug in the project"
+  #   file: "bug-report.yml"
+  - name: 📢 Connect on slack
+    url: https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg
+    about: Support OpenIM-related requests or issues, get in touch with developers and help on slack
+  - name: 🌐 OpenIM Blog
+    url: https://www.openim.io/
+    about: Open the OpenIM community blog

.github/ISSUE_TEMPLATE/deployment.yml

@@ -0,0 +1,65 @@
+name: Deployment issue
+title: "[Deployment] "
+labels: ["deployment"]
+description: "Create a detailed report to help us identify and resolve deployment issues."
+# assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: "Thank you for taking the time to fill out the deployment issue report. Please provide as much information as possible to help us understand and resolve the issue."
+
+  - type: input
+    id: openim-server-version
+    attributes:
+      label: OpenIM Server Version
+      description: "Please provide the version number of OpenIM Server you are using."
+      placeholder: "e.g., 3.8.0"
+    validations:
+      required: true
+
+  - type: dropdown
+    id: operating-system
+    attributes:
+      label: Operating System and CPU Architecture
+      description: "Please select the operating system and describe the CPU architecture."
+      options:
+        - Linux (AMD)
+        - Linux (ARM)
+        - Windows (AMD)
+        - Windows (ARM)
+        - macOS (AMD)
+        - macOS (ARM)
+    validations:
+      required: true
+
+  - type: dropdown
+    id: deployment-method
+    attributes:
+      label: Deployment Method
+      description: "Please specify how OpenIM Server was deployed."
+      options:
+        - Source Code Deployment
+        - Docker Deployment
+    validations:
+      required: true
+
+  - type: textarea
+    id: issue-description-reproduction
+    attributes:
+      label: Issue Description and Steps to Reproduce
+      description: "Provide a detailed description of the issue and a step-by-step guide on how to reproduce it."
+      placeholder: "Describe the issue in detail here...\n\nSteps to reproduce the issue on the server:\n1. Start the server with specific configurations (mention any relevant config details).\n2. Make an API call to '...' endpoint with the following payload '...'.\n3. Observe the behavior and note any error messages or logs.\n4. Mention any additional setup relevant to the bug (e.g., database version, external service dependencies)."
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: "If possible, please add screenshots to help explain your problem."
+
+  - type: textarea
+    id: screenshots-link
+    attributes:
+      label: Screenshots Link
+      description: "If applicable, please provide any links to screenshots here."
+      placeholder: "Paste your screenshot URL here, e.g., http://imgur.com/example"

.github/ISSUE_TEMPLATE/documentation.md

@@ -0,0 +1,20 @@
+---
+name: Documentation Update
+about: Propose updates to documentation, including README files and other docs.
+title: "[DOC]: "  # Prefix for the title to help identify documentation issues
+labels: documentation  # Labels to be automatically added
+assignees: ''  # Optionally, specify maintainers or teams to be auto-assigned
+
+---
+
+## Documentation Updates
+Describe the documentation that needs to be updated or corrected. Please specify the files and sections if possible.
+
+## Motivation
+Explain why these updates are necessary. What is missing, misleading, or outdated?
+
+## Suggested Changes
+Detail the changes that you propose. If you are suggesting large changes, include examples or mockups of what the updated documentation should look like.
+
+## Additional Information
+Include any other information that might be relevant, such as links to discussions or related issues in the repository.

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,43 @@
+name: Feature Request
+title: "[FEATURE REQUEST] "
+labels: ["feature request","enhancement"]
+description: "Propose a new feature or improvement that you believe will help enhance the project."
+# assignees: []
+
+body:
+  - type: markdown
+    attributes:
+      value: "Thank you for taking the time to propose a feature request. Please fill in as much detail as possible to help us understand why this feature is necessary and how it should work."
+
+  - type: textarea
+    id: feature-reason
+    attributes:
+      label: Why this feature?
+      description: "Explain why this feature is needed. What problem does it solve? How does it benefit the project and its users?"
+      placeholder: "Describe the need for this feature..."
+    validations:
+      required: true
+
+  - type: textarea
+    id: solution-proposal
+    attributes:
+      label: Suggested Solution
+      description: "Describe your proposed solution for this feature. How do you envision it working?"
+      placeholder: "Detail your solution here..."
+    validations:
+      required: true
+
+  - type: markdown
+    attributes:
+      value: "Please provide any other relevant information or screenshots that could help illustrate your idea."
+
+  - type: textarea
+    id: additional-info
+    attributes:
+      label: Additional Information
+      description: "Include any additional information, links, or screenshots that might be relevant to your feature request."
+      placeholder: "Add more context or links to relevant resources..."
+
+  - type: markdown
+    attributes:
+      value: "Thank you for contributing to the project! We appreciate your input and will review your suggestion as soon as possible."

.github/ISSUE_TEMPLATE/other.yml

@@ -0,0 +1,30 @@
+name: 🐧 Other
+description: Use this for any other issues. Please do NOT create blank issues
+title: "[Other]: <give this problem a name>"
+labels: ["other"]
+# assignees: []
+
+
+body:
+  - type: markdown
+    attributes:
+      value: "# Other issue"
+  - type: textarea
+    id: issuedescription
+    attributes:
+      label: What would you like to share?
+      description: Provide a clear and concise explanation of your issue.
+    validations:
+      required: true
+  - type: textarea
+    id: extrainfo
+    attributes:
+      label: Additional information
+      description: Is there anything else we should know about this issue?
+    validations:
+      required: false
+  - type: markdown
+    attributes:
+      value: |
+        You can also join our Discord community [here](https://join.slack.com/t/openimsdk/shared_invite/zt-1tmoj26uf-_FDy3dowVHBiGvLk9e5Xkg)
+        Feel free to check out other cool repositories of the openim Community [here](https://github.com/openimsdk)

.github/ISSUE_TEMPLATE/rfc.md

@@ -0,0 +1,26 @@
+---
+name: RFC - Feature Proposal
+about: Submit a proposal for a significant feature to invite community discussion.
+title: "[RFC]: "  # Prefix for the title to help identify RFC proposals
+labels: rfc, proposal  # Labels to be automatically added
+assignees: ''  # Optionally, specify maintainers or teams to be auto-assigned
+
+---
+
+## Proposal Overview
+Briefly describe the content and objectives of your proposal.
+
+## Motivation
+Why is this new feature necessary? What is the background of this problem?
+
+## Detailed Design
+Describe the technical details of the proposal, including implementation steps, code snippets, or architecture diagrams.
+
+## Alternatives Considered
+Have other alternatives been considered? Why is this approach preferred over others?
+
+## Impact
+How will this proposal affect existing practices and community users?
+
+## Additional Information
+Include any other relevant information such as related discussions, prior related work, etc.