docs: 开源规范化 — doc comments + 社区文件 + 示例代码 + crates.io 就绪
- 为 core 公开 API 添加完整 doc comments(rustdoc 可用) - 新增 .editorconfig / CONTRIBUTING / CODE_OF_CONDUCT / SECURITY - 新增 Issue 模板(bug + feature)+ PR 模板 - 新增 3 个代码示例(examples/) - 更新 Cargo.toml 元数据(description/repository/keywords/categories/MSRV) - 更新 README + CHANGELOG
This commit is contained in:
@@ -0,0 +1,29 @@
|
||||
---
|
||||
name: Bug 报告
|
||||
about: 报告一个问题,帮助我们改进
|
||||
title: "[Bug] "
|
||||
labels: bug
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**描述问题**
|
||||
一句话描述你遇到什么 bug。
|
||||
|
||||
**复现步骤**
|
||||
1. 执行 `...`
|
||||
2. 输入 `...`
|
||||
3. 看到错误 `...`
|
||||
|
||||
**预期行为**
|
||||
你期望发生什么?
|
||||
|
||||
**截图或日志**
|
||||
如果适用,粘贴错误日志或截图。
|
||||
|
||||
**环境**
|
||||
- OS: [如 Windows 11, macOS 15]
|
||||
- Rust 版本: [`rustc --version` 输出]
|
||||
- QRGen 版本: [v0.1.0 或 commit hash]
|
||||
|
||||
**补充信息**
|
||||
其他相关内容。
|
||||
@@ -0,0 +1,19 @@
|
||||
---
|
||||
name: 功能请求
|
||||
about: 提出一个新功能或改进建议
|
||||
title: "[Feature] "
|
||||
labels: enhancement
|
||||
assignees: ''
|
||||
---
|
||||
|
||||
**动机**
|
||||
这个功能解决什么问题?你的使用场景是什么?
|
||||
|
||||
**方案描述**
|
||||
描述你期望的方案。如果有 API 设计,请写出伪代码。
|
||||
|
||||
**备选方案**
|
||||
你考虑过哪些替代方案?
|
||||
|
||||
**补充信息**
|
||||
截图、参考链接等。
|
||||
@@ -0,0 +1,35 @@
|
||||
## 概述
|
||||
|
||||
<!-- 一句话描述这个 PR 做了什么 -->
|
||||
|
||||
## 变更类型
|
||||
|
||||
- [ ] Bug 修复
|
||||
- [ ] 新功能
|
||||
- [ ] 重构(无功能变更)
|
||||
- [ ] 文档更新
|
||||
- [ ] 测试
|
||||
- [ ] 其他:
|
||||
|
||||
## 测试
|
||||
|
||||
<!-- 描述你如何验证这个 PR -->
|
||||
|
||||
- [ ] `cargo test` 全部通过
|
||||
- [ ] `cargo clippy -- -D warnings` 无警告
|
||||
- [ ] `cargo fmt` 已运行
|
||||
- [ ] 新增测试:
|
||||
|
||||
## 截图(如适用)
|
||||
|
||||
## 关联 Issue
|
||||
|
||||
Closes #
|
||||
|
||||
## 检查清单
|
||||
|
||||
- [ ] 代码已自审
|
||||
- [ ] 注释清晰(中文)
|
||||
- [ ] 文档已更新
|
||||
- [ ] 无硬编码密钥
|
||||
- [ ] 无破坏性变更(或已标注)
|
||||
Reference in New Issue
Block a user