Skip to content

Latest commit

 

History

History
30 lines (25 loc) · 1.93 KB

procedure.md

File metadata and controls

30 lines (25 loc) · 1.93 KB

编写步骤如下

###一. 准备

  • 填写时间计划表
    读完本文档后,根据自己的时间安排,填写 时间计划表,在编写的每个阶段完成后更新时间计划表

###二. 编写该开源库的使用示例 到 android-open-project-demo 项目下新建文件夹,用于后续上传该开源库使用示例工程代码

  • 该文件夹以开源库名-demo命名,全小写,单词间用-连接。
    如果已有该文件夹,则以开源库名-demo-${GitHub 用户名}命名,如glide-demo-lightSky
  • 示例工程要求覆盖到该开源项目所有功能,不允许拷贝官方 Demo;
  • 文件夹下需要有名为 apk 的子文件夹,用于存放可运行 APK 文件;
  • 文件夹下需要有名为 README.md 的介绍文件,其中包含以下内容。
    (1). Demo Download
    (2). Screenshot 截图可使用 licecap
    具体可参考:EventBus Demo ReadMe

###三. 编写原理文档
android-open-project-analysismaster分支下新建文件夹,用于分析文档及相关资源

####3.1 文件夹规范

  • 该文件夹以开源库名命名,全小写,单词间用-连接。如果已有该文件夹,则以开源库名-${GitHub 用户名}命名,如glide-lightSky
  • 拷贝模板文件 README.md,复制到上面的文件夹中
    README.md 中所有内容用 Markdown 编写
    如果内容较多可分多个 md 文件,但 README.md 为总体的概括文件;
  • 文件夹下可有名为image子文件夹存放相关流程图等图片,uml子文件夹存放 uml 文件。

####3.2 文档需包含的模块及预计时间
具体编写的模块及各模块预计耗时请参考:zen README