🔨 修改文档.

This commit is contained in:
lijiahangmax
2025-09-09 22:45:23 +08:00
parent 919e8383bf
commit 6b44e193f5
5 changed files with 117 additions and 0 deletions

View File

@@ -0,0 +1,10 @@
### *当前使用版本 (必填)
### 问题描述
### 该问题是如何引起的
### 重现步骤
### 报错信息

View File

@@ -0,0 +1,8 @@
### 修改描述
### 关联的 Issue
### 测试用例
### 修复效果的截屏

59
.github/ISSUE_TEMPLATE/bug_report.yml vendored Normal file
View File

@@ -0,0 +1,59 @@
name: 错误报告
description: File a bug report.
title: "[错误报告]: "
labels: [""]
body:
- type: markdown
attributes:
value: |
在提交前请确认:
- 使用的是[最新版本](https://github.com/dromara/orion-visor/releases)
- 参考了[安装文档](https://visor.orionsec.cn/quickstart/docker.html)
- 查阅了[常见问题](https://visor.orionsec.cn/support/faq.html)
- 搜索了[已有 issue](https://github.com/dromara/orion-visor/issues)
- type: checkboxes
id: confirm
attributes:
label: 确认
description: 在提交 issue 之前, 请确认你已经阅读并确认以下内容
options:
- label: 我使用的是最新版本 [最新版](https://github.com/dromara/orion-visor/releases)
required: true
- label: 我使用官方文档进行部署 [安装文档](https://visor.orionsec.cn/quickstart/docker.html)
required: true
- label: 我已检查了 [常见问题](https://visor.orionsec.cn/support/faq.html) 并没有找到解决方法
required: true
- label: 我已搜索 [issue](https://github.com/dromara/orion-visor/issues) 并没有找到相关问题
required: true
- type: input
id: version
attributes:
label: 当前程序版本
description: 遇到问题时程序所在的版本号
validations:
required: true
- type: dropdown
id: install
attributes:
label: 安装方式
options:
- Docker
- 普通安装
- 其他
validations:
required: true
- type: textarea
id: what-happened
attributes:
label: 问题描述
description: 请详细描述你碰到的问题
placeholder: "问题描述"
validations:
required: true
- type: textarea
id: logs
attributes:
label: 详细日志
description: 问题出现时的程序日志
render: bash

5
.github/ISSUE_TEMPLATE/config.yml vendored Normal file
View File

@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: 官网
url: https://visor.orionsec.cn/
about: document.

View File

@@ -0,0 +1,35 @@
name: 功能改进
description: 提出新功能建议 (请提交到需求收集帖)
title: "[功能建议]: "
labels: [""]
body:
- type: markdown
attributes:
value: |
所有功能建议请统一提交到需求收集帖: 🔗 [#83 需求收集](https://github.com/dromara/orion-visor/issues/83)
在提交前请确认:
- ✅ 使用的是[最新版本](https://github.com/dromara/orion-visor/releases)
- ✅ 已搜索[已有 issue](https://github.com/dromara/orion-visor/issues) 和 需求收集帖避免重复
- ✅ 定制化需求请联系作者
---
### 如何提交高质量建议?
1. **功能描述**: 你希望增加什么?
2. **使用场景**: 你在什么情况下需要它?
4. **参考实现**: 开源项目中的类似功能(**禁止引用商业闭源软件**
- type: textarea
id: feature
attributes:
label: 功能改进
description: 请详细描述需要改进或者添加的功能。
placeholder: "功能改进"
validations:
required: true
- type: textarea
id: references
attributes:
label: 参考资料
description: 可以列举一些参考资料, 但是不要引用同类但商业化软件的任何内容。
placeholder: "参考资料"