Merge branch 'main' into develop

.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,85 @@
+name: Bug Report
+description: Create a report to help us improve
+labels: ['bug']
+body:
+  - type: checkboxes
+    id: checks
+    attributes:
+      label: Before you asking
+      options:
+      - label: I have searched the existing issues
+        required: true
+      - label: I spend at least 5 minutes for thinking and preparing
+        required: true
+      - label: I have carefully checked the issue, and it is unrelated to the network environment.
+        required: true
+  - type: markdown
+    attributes:
+      value: |
+        Thank you for using this project and providing feedback!
+  - type: textarea
+    id: environment
+    attributes:
+      label: Environment
+      description: |
+        examples:
+          - **OS**: Ubuntu 24.10
+          - **Python**: 3.12.0
+          - **BalbelDOC**: 1.9.0
+      value: |
+          - OS:
+          - Python:
+          - BalbelDOC:
+      render: markdown
+    validations:
+      required: false
+  - type: textarea
+    id: describe
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: To Reproduce
+      description: Steps to reproduce the behavior
+      value: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: false
+  - type: textarea
+    id: expected
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+    validations:
+      required: false
+  - type: textarea
+    id: logs
+    attributes:
+      label: Relevant log output and screenshots
+      description: Please copy and paste any relevant log output and screenshots. This will be automatically formatted into code, so no need for backticks.
+      render: Text
+    validations:
+      required: false
+  - type: textarea
+    id: PDFfile
+    attributes:
+      label: Origin PDF file
+      description: |
+        if applicable, attach the input PDF file here.
+    validations:
+      required: false
+  - type: textarea
+    id: others
+    attributes:
+      label: Anything else?
+      description: |
+        Add any other context about the problem here.
+    validations:
+      required: false

.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,33 @@
+name: Feature request
+description: Suggest an idea for this project
+labels: ['enhancement']
+body:
+  - type: textarea
+    id: describe
+    attributes:
+      label: Is your feature request related to a problem?
+      description: A clear and concise description of what the problem is
+      placeholder: Ex. I'm always frustrated when ...
+    validations:
+      required: false
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen
+    validations:
+      required: false
+  - type: textarea
+    id: 
+    attributes:
+      label: Describe alternatives you've considered
+      description: A clear and concise description of any alternative solutions or features you've considered.
+    validations:
+      required: false
+  - type: textarea
+    id: additional
+    attributes:
+      label: Additional context
+      description: Add any other projects about the feature request here.
+    validations:
+      required: false

docs/CONTRIBUTING.md

@@ -40,7 +40,7 @@ Please pay special attention to:
 
 
 1. Fork this repository and clone it locally.
-2. Use `doc/deploy.sh` to set up the development  environment.
+2. Use `doc/deploy.sh` to set up the development environment.
 3. Create a new branch and make code changes on that branch. `git checkout -b feature/<feature-name>`
 4. Perform development and ensure the code meets the requirements.
 
@@ -72,6 +72,8 @@ git commit -m "<semantic commit message>"
 
 - Use the `uv run yadt` command for development and testing.
 
+- When you need print log, please use `log.debug()` to print info. **DO NOT USE `print()`**
+
 - Code formatting
 
 3. Dependency Updates