Swit 框架

中文

English

中文

English

Appearance

用户反馈与贡献指南 ​

我们重视您的反馈和贡献，这有助于让Swit项目网站变得更好。本指南说明如何帮助改进文档、报告问题以及为项目做出贡献。

贡献方式 ​

📝 文档改进 ​

内容更新

  • 修复拼写、语法或格式问题
  • 更新过时信息
  • 添加缺失的解释或详情
  • 提高清晰度和可读性

新内容创建

  • 编写新的教程和指南
  • 创建代码示例和用例
  • 添加FAQ条目
  • 贡献翻译改进

🐛 错误报告 ​

网站问题

  • 断链或导航问题
  • 不同设备上的显示问题
  • 性能问题
  • 无障碍访问问题

内容问题

  • 不正确或过时的信息
  • 缺失的代码示例
  • 代码样本错误
  • 翻译错误

💡 功能建议 ​

用户体验

  • 导航改进
  • 搜索增强
  • 移动体验优化
  • 无障碍访问功能

内容功能

  • 新的文档章节
  • 交互式示例
  • 视频教程
  • 高级搜索过滤器

如何提交反馈 ​

GitHub Issues（推荐） ​

用于错误报告和功能请求：

  1. 访问：项目GitHub Issues
  2. 搜索：检查问题是否已存在
  3. 创建：如果未找到，点击"New Issue"
  4. 选择模板：选择适当的问题模板
  5. 提供详情：完整填写模板

可用问题模板：

  • 🐛 错误报告
  • 🚀 功能请求
  • 📚 文档问题
  • 🌐 翻译请求

GitHub Discussions ​

用于问题和一般反馈：

  1. 访问：项目讨论
  2. 浏览：检查现有话题
  3. 开始讨论：如需要，创建新话题
  4. 选择类别：选择适当的类别

讨论类别：

  • 💬 一般问题
  • 💡 想法和建议
  • 🙏 寻求帮助
  • 📢 公告

直接贡献 ​

快速修复 ​

对于小的更正（拼写、链接等）：

  1. 找到页面：导航到有问题的页面
  2. 在GitHub上编辑：点击"编辑此页面"链接
  3. 进行更改：直接在GitHub上编辑
  4. 提交PR：创建包含您更改的拉取请求

重大更改 ​

对于重要的内容添加或修改：

  1. Fork仓库：创建您自己的副本
  2. 创建分支：创建功能分支
  3. 进行更改：在本地编辑文件
  4. 测试更改：验证您的更改正常工作
  5. 提交PR：创建带详细描述的拉取请求

反馈指南 ​

编写有效的错误报告 ​

包含这些详情：

  • 页面URL：问题发生的确切页面
  • 浏览器信息：浏览器版本和操作系统
  • 重现步骤：重现问题的清晰步骤
  • 预期行为：应该发生什么
  • 实际行为：实际发生了什么
  • 截图：问题的视觉证据

错误报告示例：

**页面URL**: https://yourusername.github.io/swit/zh/api/server
**浏览器**: Chrome 120.0 on Windows 11
**问题**: 代码示例复制按钮不工作

**重现步骤**:
1. 访问API文档页面
2. 滚动到第一个代码示例
3. 点击复制按钮
4. 没有任何反应

**预期**: 代码应该复制到剪贴板
**实际**: 按钮点击无效果

建议功能 ​

要具体：

  • 清楚描述提议的功能
  • 解释它解决的问题
  • 提供用例示例
  • 考虑实现复杂性

功能请求示例：

**功能**: 导航栏中的暗色模式切换
**问题**: 用户喜欢使用暗色模式阅读文档
**解决方案**: 在顶部导航栏添加主题切换按钮
**好处**: 更好的用户体验，减少眼部疲劳

内容建议 ​

文档改进：

  • 指出不清楚的章节
  • 建议额外示例
  • 请求缺失的主题
  • 提议更好的组织结构

翻译改进：

  • 报告翻译错误
  • 建议更好的术语
  • 提供翻译帮助
  • 指出文化考量

内容指南 ​

写作风格 ​

语调和声音：

  • 清晰简洁的语言
  • 专业而友好的语调
  • 尽可能避免术语
  • 使用主动语态

结构：

  • 使用适当的标题层次
  • 在有用的地方包含代码示例
  • 添加导航辅助（目录、链接）
  • 遵循既定模式

代码示例 ​

要求：

  • 可工作、经过测试的代码
  • 适当的语法高亮
  • 清晰的注释和解释
  • 完整、可运行的示例

最佳实践：

go
// 好的：清晰、有注释的示例
func main() {
    // 初始化服务器配置
    config := &server.ServerConfig{
        Port: 8080,
        Host: "localhost",
    }
    
    // 创建并启动服务器
    server, err := server.NewBusinessServer(config)
    if err != nil {
        log.Fatal("创建服务器失败:", err)
    }
    
    server.Start()
}

Markdown标准 ​

格式化：

  • 使用适当的标题级别（#、##、###）
  • 使用三个反引号格式化代码
  • 适当使用粗体和斜体
  • 包含适当的frontmatter

链接和引用：

  • 使用描述性链接文本
  • 链接到相关章节
  • 包含外部引用
  • 检查断链

认可和归属 ​

贡献者认可 ​

我们认可所有贡献者：

GitHub贡献者：

  • 在仓库贡献者部分列出
  • 重要贡献在发布说明中提及
  • 持续贡献者特别认可

文档创作者：

  • 重要内容添加的作者归属
  • 审查和反馈的致谢部分
  • 杰出贡献的社区展示

认可类型 ​

代码贡献者：

  • 拉取请求作者权
  • 贡献者图表可见性
  • 常规贡献者的维护者权限

内容贡献者：

  • 文章作者署名
  • 贡献者部分提及
  • 社交媒体认可

社区贡献者：

  • 社区版主角色
  • 特殊贡献者徽章
  • 会议演讲机会

入门指南 ​

首次贡献者 ​

简单的开始方式：

  1. 修复拼写：寻找拼写或语法错误
  2. 更新链接：检查断链或过时链接
  3. 改进示例：增强现有代码示例
  4. 添加上下文：为复杂主题提供更多解释

学习资源：

  • 阅读现有贡献指南
  • 研究代码库结构
  • 审查成功的拉取请求
  • 参与社区讨论

常规贡献者 ​

成长机会：

  • 成为部分维护者
  • 领导翻译工作
  • 指导新贡献者
  • 帮助发布规划

沟通渠道 ​

实时沟通 ​

GitHub讨论：最适合异步讨论
Issues：最适合跟踪具体问题
拉取请求：最适合代码/内容审查

响应期望 ​

问题报告：2-3个工作日初始响应
拉取请求：1-2周审查
讨论：社区驱动，时间不定

升级流程 ​

如果您没有收到响应：

  1. 等待：允许适当的响应时间
  2. 跟进：添加礼貌的评论询问状态
  3. 标记维护者：如果紧急，提及活跃维护者
  4. 替代渠道：尝试不同的沟通方法

特别项目 ​

贡献激励 ​

文档赏金：

  • 高优先级文档需求的奖励
  • 困难主题的特别认可
  • 会议门票赞助

翻译项目：

  • 协调翻译工作
  • 翻译完整性认可
  • 文化适应指导

社区活动 ​

贡献推动：

  • 组织贡献会议
  • 文档冲刺
  • 翻译马拉松

认可活动：

  • 年度贡献者奖
  • 社区亮点帖子
  • 会议演示

对本指南的反馈 ​

这个指南本身也可以改进！请：

  • 报告不清楚的部分
  • 建议额外信息
  • 分享您的贡献经验
  • 提议流程改进

使用上述相同的反馈渠道帮助我们改进这个指南。

感谢您帮助改进Swit项目文档，让每个人都受益！无论您的贡献大小，都帮助整个社区获得成功。

Released under the MIT License.

Copyright © 2025 Swit Framework Contributors