贡献指南

如何为 Awesome Sites 项目贡献内容

贡献指南 🤝

感谢你对 Awesome Sites 项目的关注！我们欢迎所有形式的贡献。

📋 贡献类型

  • 🆕 添加新网站 - 推荐有价值的网站
  • 🔧 修复错误 - 修复失效链接、错误描述等
  • 💡 改进建议 - 提出项目改进意见
  • 📝 完善文档 - 改进README或其他文档
  • 🏷️ 优化分类 - 调整分类结构或标签

🚀 快速开始

方式一：提交 Issue

适合快速推荐网站或报告问题

  1. 点击 Issues
  2. 选择合适的模板
  3. 填写必要信息
  4. 提交Issue

方式二：提交 Pull Request

适合直接贡献代码

  1. Fork 这个仓库
  2. Clone 到本地：git clone https://github.com/HK-bruc1/awesome-sites.git
  3. 创建分支：git checkout -b add-new-site
  4. 进行修改
  5. 提交修改：git commit -m "Add: 新网站名称"
  6. 推送分支：git push origin add-new-site
  7. 创建 Pull Request

📝 网站添加规范

基本要求

  • ✅ 网站必须可正常访问
  • ✅ 内容质量高，对用户有实际价值
  • ✅ 不含恶意软件或有害内容
  • ✅ 避免重复添加相似功能网站

格式要求

| [网站名称](https://example.com) | 简洁的描述(20字内) | `标签1` `标签2` `标签3` |

描述指南

  • 用一句话说明网站的主要功能
  • 突出网站的核心特色
  • 避免使用”最好的”、”完美的”等主观形容词
  • 使用中文描述

标签指南

  • 每个网站最多3个标签
  • 使用简洁的中文词汇
  • 常用标签：免费 开源 中文 API 工具 学习 设计
  • 新标签需要在多个网站中重复使用才有意义

分类指南

选择最合适的分类，如果不确定可以在PR中说明。现有分类：

  • 🛠️ 开发工具 - 编程开发相关工具
  • 📚 学习资源 - 教育学习平台
  • 🎨 设计相关 - 设计工具和素材
  • ⚡ 实用工具 - 日常实用的在线工具
  • 🎯 AI 工具 - 人工智能相关应用
  • 🌐 资源下载 - 素材资源下载站
  • 📊 数据可视化 - 数据分析和可视化
  • 🔧 系统工具 - 系统级实用工具

🎯 Issue 模板

推荐新网站

**网站名称：** 
**网站链接：** 
**所属分类：** 
**网站描述：** 
**推荐理由：** 
**建议标签：**

报告问题

**问题类型：** [失效链接/错误描述/分类错误/其他]
**涉及网站：** 
**问题描述：** 
**建议修改：**

✅ Pull Request 规范

提交信息格式

  • Add: 网站名称 - 添加新网站
  • Fix: 修复内容 - 修复问题
  • Update: 更新内容 - 更新信息
  • Docs: 文档更新 - 文档修改

检查清单

提交前请确认：

  • 链接可正常访问
  • 描述简洁准确(≤20字)
  • 标签合适(≤3个)
  • 按字母顺序插入
  • 格式正确
  • 分类恰当

🚫 不接受的内容

  • ❌ 违法违规网站
  • ❌ 包含恶意软件的网站
  • ❌ 需要付费才能使用核心功能的网站(除非特别优秀)
  • ❌ 个人博客(除非内容特别有价值)
  • ❌ 纯商业广告网站
  • ❌ 内容质量低下的网站
  • ❌ 长期无法访问的网站

🏆 贡献者Recognition

我们会在README中感谢所有贡献者！贡献类型包括：

  • 🌟 Gold Contributors - 贡献10+个优质网站
  • 🥈 Silver Contributors - 贡献5-9个优质网站
  • 🥉 Bronze Contributors - 贡献1-4个优质网站
  • 🔧 Maintainers - 项目维护者
  • 🐛 Bug Hunters - 报告问题的用户

💬 讨论和反馈

  • 💭 Discussions - 项目相关讨论
  • 📧 Email - 私密反馈和建议
  • 🐛 Issues - Bug报告和功能请求

📄 行为准则

参与项目时请遵循：

  1. 尊重他人 - 友善对待所有参与者
  2. 建设性沟通 - 提供有价值的反馈
  3. 质量第一 - 确保贡献内容的质量
  4. 开放心态 - 接受不同观点和建议

再次感谢你的贡献！每一个贡献都让这个项目变得更好。🙏