优化 Gitee Issue 模板和文档细节

优化 Gitee Issue 模板和文档细节

.gitee/ISSUE_TEMPLATE/bug.yml

@@ -1,40 +1,60 @@
-name: 问题反馈
-description: 使用 Layui 过程中遇到的 Bug、异常或其他困惑。😇 -
+name: 😇 问题反馈
+description: 使用 Layui 过程中遇到的 Bug、异常或其他困惑。
 title: ""
-labels: ["bug"]
 body:
   - type: markdown
     attributes:
       value: |
         在反馈问题之前，请确保：
-        - 您已查看官方使用文档：**https://layui.dev** ，但没有找到相关解决方案。 
-        - 您已在 Issues 中搜索过类似的问题，但没有找到相关解决方案。
+        - 已查看官方使用文档：**https://layui.dev** ，但没有找到相关解决方案。 
+        - 已在 **Issues** 中搜索过类似的问题，但没有找到相关解决方案。
   - type: input
     attributes:
-        label: 版本号
-        placeholder: 请提供您所使用的 Layui 版本号
+      label: 版本号
+      placeholder: 请提供您所使用的 Layui 版本号
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: 浏览器
+      placeholder: 如：Chrome 115.0.5735.91（正式版本） （64 位）
+    validations:
+      required: true
+  - type: dropdown
+    id: type
+    attributes:
+      label: 问题类型
+      options:
+        - 疑是 BUG
+        - 报错提示
+        - 功能困惑
     validations:
       required: true
   - type: textarea
     attributes:
       label: 问题描述
-      placeholder: 请提供尽可能详细的问题描述和具体操作步骤等信息，以便我们也能够更轻松地将问题复现。
+      placeholder: 请提供详细的问题描述和操作步骤等信息，以便我们也能够更轻松地将问题复现。
     validations:
       required: true
   - type: textarea
     attributes:
       label: 业务代码
+      description: 直接粘贴问题对应的 `HTML,CSS,JavaScript` 等代码到下面的文本框，无需书写 `Markdown`
       placeholder: 请提供与该问题对应的业务代码片段，以便我们更好地排查问题。
-      render: html
+      render: auto
     validations:
       required: true
   - type: textarea
     attributes:
       label: 截图补充
-      placeholder: 若上述无法准确地表述问题，可提供必要的截图（支持粘贴上传）
+      placeholder: 如上述仍然无法准确地表述问题，可提供必要的截图（可直接粘贴上传）
+  - type: input
+    attributes:
+      label: 演示地址
+      placeholder: 若能提供 CodePen、Stackblitz 或自主搭建的页面演示地址，将更有助于解决问题
   - type: checkboxes
     attributes:
       label: 友好承诺
       options:
         - label: 我承诺将本着相互尊重、理解和友善的态度进行交流，共同维护 Layui 良好的社区氛围。
-          required: true
+          required: true

.gitee/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: 📄 阅读文档
+    url: https://layui.dev/
+    about: 建议你在创建 Issue 之前，仔细查阅 Layui 开发文档，以便对其有更深入的了解，和更好地分析问题。

.gitee/ISSUE_TEMPLATE/feature.yml

@@ -1,19 +1,26 @@
-name: 功能建议
-description: 对 Layui 提出您的宝贵建议。😄 - 
+name: 😄 功能建议
+description: 对 Layui 提出合理且有效的建议。
 title: ""
-labels: ["enhancement"]
-body:
+labels: ["建议"]
+body: 
   - type: textarea
     id: related-problem
     attributes:
       label: 建议内容
-      placeholder: 阐述提出该建议的出发点。
+      placeholder: 阐述提出该建议的出发点，请认真填写。
     validations:
       required: true
   - type: textarea
     id: desired-solution
     attributes:
       label: 解决方案
-      placeholder: 您希望看到什么样的解决方案？
+      placeholder: 你希望得到什么样的解决方案？
     validations:
-      required: true
+      required: true
+  - type: textarea
+    id: additional-context
+    attributes:
+      label: 截图说明
+      placeholder: 在此处添加有关功能请求的相关截图（支持粘贴上传）。
+    validations:
+      required: false

docs/form/checkbox.md

@@ -103,7 +103,7 @@ layui.use(function(){
   <div class="layui-form-item">
     <input type="checkbox" name="BBB" value="1" lay-skin="tag">
     <div lay-checkbox>
-      <i class="layui-icon layui-icon-heart"></i> 标题模板</span>
+      <i class="layui-icon layui-icon-heart" style="position: relative; top: 1px; line-height: normal;"></i> 标题模板
     </div>
   </div>
   <div class="layui-form-item">

docs/form/examples/form.demo.md

@@ -164,7 +164,7 @@
     <div class="layui-input-block">
       <input type="checkbox" name="arr1[0]" lay-skin="tag" title="选项1" checked>
       <input type="checkbox" name="arr1[1]" lay-skin="tag" title="选项2">
-      <input type="checkbox" name="arr1[2]" lay-skin="tag" title="选项3" disabled>
+      <input type="checkbox" name="arr1[2]" lay-skin="tag" title="选项3">
     </div>
   </div>
   <div class="layui-form-item">

docs/modules.md

@@ -144,7 +144,7 @@ layui.use('demo', layui.factory('demo'));
 
 2. **编写模块**
 
-接下来我们开始定义 `firstMod` 模块，并编写改模块主体代码。
+接下来我们开始定义 `firstMod` 模块，并编写该模块主体代码。
 
 ```
 /**

docs/table/detail/demo.md

@@ -168,7 +168,7 @@
 
 <h3 id="demo-setRowChecked" lay-toc="{level: 2, hot: true}" class="ws-bold">选中行操作</h3>
 
-点击行任意处，通过行事件中执行相关选中方法，实现对整行的状态选中。
+点击行任意处，通过行事件中执行相关选中方法，实现对整行的状态选中。*如下以「单选」行为例：*
 
 <pre class="layui-code" lay-options="{preview: true, codeStyle: 'height: 508px;', layout: ['preview', 'code'], tools: ['full'], toolsEvent: function(oi, type){
   if(type === 'full'){

docs/table/examples/search.md

@@ -40,7 +40,7 @@ layui.use(function(){
     elem: '#ID-table-demo-search',
     url: '/static/2.8/json/table/user.json', // 此处为静态模拟数据，实际使用时需换成真实接口
     cols: [[
-      {checkbox: true, fixed: true},
+      {type: 'radio', title: '😊', fixed: true}, // 单选框
       {field:'id', title: 'ID', width:80, sort: true, fixed: true},
       {field:'username', title: '用户名', width:80},
       {field:'sex', title: '性别', width:80, sort: true},

docs/table/examples/setRowChecked.md

@@ -16,7 +16,7 @@ layui.use('table', function(){
     url: '/static/2.8/json/table/user.json', // 此处为静态模拟数据，实际使用时需换成真实接口
     page: true,
     cols: [[
-      {type: 'radio', fixed: 'left'},
+      // {type: 'radio', fixed: 'left'},
       {field:'id', title:'ID', width:80, fixed: 'left', unresize: true},
       {field:'username', title:'用户', width:120},
       {field:'sex', title:'性别', width:80},
@@ -43,7 +43,7 @@ layui.use('table', function(){
 
     // 标注当前点击行的选中状态
     obj.setRowChecked({
-      type: 'radio' // 单选模式
+      type: 'radio' // radio 单选模式；checkbox 复选模式
     });
   });
 

docs/table/index.md

@@ -651,7 +651,7 @@ table.render({
   // … // 其他属性
 });
  
-// 列拖拽宽度后的事件
+// 表头自定义元素工具事件
 table.on('colTool(test)', function(obj){
   var col = obj.col; // 获取当前列属性配置项
   var options = obj.config; // 获取当前表格基础属性配置项