Ant Design 在 2015 年 5 月 7 日第一次提交代码,全部提交和讨论都在 GitHub 进行,无内网版本,是一个完全开源的前端项目。


本文基于 Ant Design 多年来的项目运作,与大家交流开源项目的运作经验,主要内容围绕项目文档网站代码规范和风格单元测试发布规范开源项目运营等几大方面,为大家提供实用的指引。


Ant Design 开源项目经验分享,你想知道的都在这儿了_javaAnt Design 开源项目经验分享,你想知道的都在这儿了_java_02



项目文档


README


项目的 README 应该包含对项目的核心描述,内容应包括:


  • 一句话描述:解决什么问题?

  • Badges:这个项目靠不靠谱?

  • 特性:有什么?有什么不一样?

  • 使用方式:看一眼是什么

  • 必要截图:看一眼是什么

  • 开发指引:如何本地开发?

  • 参考项目:

    • standard-readme(https://github.com/RichardLitt/standard-readme

    • ice(https://github.com/alibaba/ice/

    • f2(https://github.com/antvis/f2/


Ant Design 开源项目经验分享,你想知道的都在这儿了_java_03




上手文档


为了给程序员提供愉快的开发体验,手把手(Steps by Steps)的快速上手使用文档非常重要。


  • README

  • 快速上手手把手的文档,让用户有第一印象https://ant.design/docs/react/getting-started-cn

  • 在 create-react-app 中使用:和社区对齐https://ant.design/docs/react/use-with-create-react-app-cn

  • 在 TypeScript 中使用:和社区对齐https://ant.design/docs/react/use-in-typescript-cn

  • 项目实战:面向高级用户,推广 Umihttps://ant.design/docs/react/practical-projects-cn


关键点:手把手(Steps by Steps)


FAQ


为一些常见的问题整理官方回复,可以省去很多答疑成本。内容可以包括:


  • FAQ 文档(https://ant.design/docs/react/faq-cn

  • 组件文档的 FAQ 部分(https://ant.design/components/form-cn/#FAQ

  • Issue 标签(https://github.com/ant-design/ant-design/issues?q=is:issue+label:❓FAQ+is:closed


关键点:保持更新!


Badges


使用 Badges 可以通过一些核心的指标去了解项目的概况。参考:


Ant Design 开源项目经验分享,你想知道的都在这儿了_java_04

Ant Design 开源项目经验分享,你想知道的都在这儿了_java_05

Ant Design 开源项目经验分享,你想知道的都在这儿了_java_06

  • CI 服务 Ant Design 开源项目经验分享,你想知道的都在这儿了_java_07

  • 覆盖率Ant Design 开源项目经验分享,你想知道的都在这儿了_java_08

  • npmAnt Design 开源项目经验分享,你想知道的都在这儿了_java_09

  • npm downloadAnt Design 开源项目经验分享,你想知道的都在这儿了_java_10

  • 依赖版本(https://david-dm.org/ant-design/ant-designAnt Design 开源项目经验分享,你想知道的都在这儿了_java_11

  • GitterAnt Design 开源项目经验分享,你想知道的都在这儿了_java_12

  • 协议安全(https://fossa.com/Ant Design 开源项目经验分享,你想知道的都在这儿了_java_13


可以使用 shields( https://shields.io/)、badgen(https://badgen.net/) 这两个 Badges 服务去装饰你精心写的项目。



网站



网站体验是用户的第一次体验,也可能是最后一次。

一个基本网站应该具备的特性:


  • ⚛ Prerendered static site