CONTRIBUTING.md

贡献指南

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

🎯 贡献类型

1. 添加新资源

如果你发现了优质的设计资源，欢迎提交 PR 添加到列表中。

提交标准：

• ✅ 可直接使用：有完整代码示例，可以复制粘贴使用
• ✅ 文档清晰：文档完善，AI 友好
• ✅ 开源免费：开源免费或有免费版本
• ✅ 活跃维护：2024-2026 年仍在维护
• ✅ Stars 数据准确：提供准确的 GitHub Stars 数据

格式要求：

| **项目名称** | 简短描述（不超过 20 字） | Stars 数 | [查看](链接) |

2. 更新 Stars 数据

如果你发现某个项目的 Stars 数据已经过时，欢迎提交 PR 更新。

更新原则：

• 只更新变化超过 1k+ 的项目
• 使用 "Xk+" 格式（如 25k+, 100k+）
• 在 PR 中注明数据来源

3. 报告问题

如果你发现以下问题，请提交 Issue：

• 链接失效
• 项目已停止维护
• 信息错误或过时
• 分类不合理

4. 改进文档

欢迎优化：

• 使用指南
• 场景示例
• 描述文案
• 排版格式

📝 提交流程

提交 Issue

1. 搜索现有 Issue，避免重复
2. 使用清晰的标题
3. 提供详细描述和截图（如适用）

提交 Pull Request

1. Fork 本仓库
2. 创建你的特性分支 (git checkout -b feature/AmazingFeature)
3. 按照上述标准进行修改
4. 提交你的更改 (git commit -m 'Add some AmazingFeature')
5. 推送到分支 (git push origin feature/AmazingFeature)
6. 打开一个 Pull Request

PR 标题格式：

• feat: 添加 XXX 资源
• update: 更新 XXX Stars 数据
• fix: 修复 XXX 链接失效
• docs: 优化 XXX 文档
• refactor: 重构 XXX 分类

PR 描述模板：

## 变更类型
- [ ] 添加新资源
- [ ] 更新 Stars 数据
- [ ] 修复问题
- [ ] 改进文档

## 变更内容
<!-- 详细描述你的变更 -->

## 相关 Issue
<!-- 如果有相关 Issue，请在此引用 -->

## 检查清单
- [ ] 已阅读贡献指南
- [ ] 符合提交标准
- [ ] 数据准确无误
- [ ] 链接有效可访问
- [ ] 格式符合规范

🚫 不接受的贡献

以下类型的 PR 将被拒绝：

• ❌ 付费专属资源（无免费版本）
• ❌ 已停止维护的项目（2 年以上无更新）
• ❌ 无完整文档或示例的项目
• ❌ 纯设计稿/Figma 文件（不含代码）
• ❌ 个人博客/教程链接
• ❌ 商业广告或营销内容

⚡ 快速贡献

如果你只是想快速报告问题或建议，可以：

1. 在 Issues 中创建问题
2. 在 Discussions 中发起讨论
3. 直接联系维护者

📊 数据来源标准

提交 Stars 数据时，请确保：

• 数据来自 GitHub 官方页面
• 截止日期为最近 1 个月内
• 四舍五入到千位（如 25.6k → 26k+）

🎨 分类规范

添加新资源时，请选择合适的分类：

• 🌐 网站开发 - 直接可用的组件库
• 🤖 AI 代码生成与设计工具
• ✨ 动画库 - 让页面动起来
• 🎮 3D 可视化
• 📱 小程序开发
• 🍎 macOS/iOS 开发
• 📱 移动 APP 开发
• 💼 后台管理系统
• 🚀 Landing Page
• 🎭 设计系统
• 🤖 AI Agents UI 框架
• 🎨 开源设计工具
• 📈 图表可视化
• 📚 更多设计资源（图标、插画、灵感等）

如果现有分类不合适，可以在 PR 中说明并建议新分类。

💬 社区准则

• 尊重所有贡献者
• 保持友好和专业的沟通
• 对建设性批评持开放态度
• 专注于对项目最有利的事情

🙏 致谢

感谢所有为 FreeDesign 做出贡献的开发者！你的每一次贡献都让这个项目变得更好。

---

有任何问题？ 随时在 Discussions 中提问！