diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..eb22a41 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,35 @@ +--- +name: Bug 报告 +about: 报告一个缺陷以帮助我们改进 +title: "[Bug] 简要描述问题" +labels: bug +assignees: '' +--- + +## 描述 + +清晰的缺陷描述。 + +## 复现步骤 + +1. 打开 '...' +2. 点击 '...' +3. 观察到 '...' + +## 期望行为 + +预期应该发生什么。 + +## 实际行为 + +实际发生了什么。 + +## 运行环境 + +- 操作系统版本:Win10 / Win11 (Build xxx) +- 应用版本:v2.0.0 +- 传输通道(如适用):ADB / WPD(MTP) / 本地 + +## 日志 + +请附上 `%LOCALAPPDATA%\FastTransfer2\logs\` 下相关日志(如有)。 diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..a7da8b3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,24 @@ +--- +name: 功能建议 +about: 提出一个新功能或改进建议 +title: "[Feature] 简要描述功能" +labels: enhancement +assignees: '' +--- + +## 使用场景 + +这个功能要解决什么问题?你在什么场景下需要它? + +## 期望能力 + +- [ ] 期望行为 1 +- [ ] 期望行为 2 + +## 备选方案 + +是否有其他可替代的实现方式? + +## 附加说明 + +补充信息或参考。 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..6de3b82 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,53 @@ +# 贡献指南 + +感谢你愿意为 **FastTransfer** 贡献力量!请遵循以下规范,让协作更顺畅。 + +## 📌 提交 Issue + +- 先搜索是否已有相同 Issue,避免重复。 +- **Bug 报告**:使用 [Bug 模板](.github/ISSUE_TEMPLATE/bug_report.md),包含复现步骤、期望行为、实际行为、运行环境。 +- **功能建议**:使用 [Feature 模板](.github/ISSUE_TEMPLATE/feature_request.md),说明使用场景与期望能力。 + +## 🍴 贡献流程 + +1. **Fork** 本仓库,并克隆到本地。 +2. 创建功能分支(命名规范见下): + ```bash + git checkout -b feature/your-feature + # 或 fix/bug-description · docs/topic · ci/improvement + ``` +3. 进行修改并**本地验证**(编译通过、无警告): + ```bash + dotnet build -c Debug -p:Platform=x64 + ``` +4. 提交(遵循约定式提交信息): + ```bash + git add . + git commit -m "feat: 添加 XXX 功能" + ``` +5. 推送到你的分支并提交 **Pull Request** 到 `master`。 +6. 在 PR 描述中说明改动内容,并**关联相关 Issue**(如 `Closes #1`)。 + +## 🧑‍💻 代码规范 + +- 语言:C# / .NET 8,目标框架 `net8.0-windows10.0.19041.0`。 +- 页面构造函数与加载事件必须包含 try-catch 保护,并用 InfoBar 展示错误。 +- 遵循现有目录结构:`Models / Services / Providers / Views`。 +- 不引入 `NotImplementedException` / TODO 占位实现。 + +## ✅ 提交信息规范 + +使用 [Conventional Commits](https://www.conventionalcommits.org/): + +| 类型 | 用途 | +|------|------| +| `feat:` | 新功能 | +| `fix:` | 修复缺陷 | +| `docs:` | 文档 | +| `refactor:` | 重构 | +| `ci:` | CI/构建 | +| `test:` | 测试 | + +## 🤝 行为准则 + +保持友善、建设性的交流。欢迎提出任何改进建议。