Skip to content

Latest commit

 

History

History
40 lines (34 loc) · 3.25 KB

procedure.md

File metadata and controls

40 lines (34 loc) · 3.25 KB

编写步骤如下

####一. 准备

  • 进群后
    按照群公告修改群昵称,以想分析的库开头。群里 @Trinea 给我发 Github 帐号
  • 填写时间计划表
    读完本文档后,根据自己的时间安排,填写 时间计划表,并在以后编写的每个阶段完成后更新时间计划表
  • 寻找 Buddy
    在协作群里找到一个后期帮忙做校验的 Buddy
  • 项目中可能用到的工具 Tool

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

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

完成时间

  • 示例工程需要在认领后三天内完成全部提交,中间每天需要有一定的提交。

####三. 编写原理文档
android-open-project-analysis 项目下新建文件夹。

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

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

####五、Buddy Check Buddy 可在最终完成后开始 Check,包括 demo apk 功能是否完善以及原理文档是否清晰。

项目中遇到的问题可汇总到 项目过程中问题

希望大家都能在分析和 Buddy 的过程中收获很多,同时分析文档能为其他开发者带来便利,一起加油!