作者:snowdream
Email:yanghui1986527#gmail.com
Github: https://github.com/snowdream
QQ 群: 529327615
原文地址:https://github.com/snowdream/awesome-android/wiki
awesome-android 开发维护指南
项目说明
本项目是为了将Github和其它网站的一些开源Android库进行索引,方便Android开发者进行查阅而创建。
项目地址
https://github.com/snowdream/awesome-android
适用范围:
本文档适合于任何想加入我们一起维护awesome-android项目的android开发者。
编写目标
用于规范awesome-android的开发维护流程。
如何加入我们
如果你是一名Android开发者,看完本文档后,希望加入我们一起维护这个项目,请通过以下方式联系我们。
- Email:yanghui1986527#gmail.com
- QQ Group: 529327615
加入要求
- Android开发者
- 熟悉git, github, markdown的使用
- 了解nodejs, gitbook者优先
收录范围
主要收录Github和其它网站的一些开源Android库和工具。
哪些库能收录
基本符合以下条件:
- Star数目大于20
- 有创意
- 开发维护比较活跃
哪些库不要收录
符合以下任何一个条件:
- 已经停止开发维护
- 还没有成型,暂不可用
收录方法
单一收录
- 首先,确定待收录的Android库。
比如: https://github.com/ToxicBakery/ViewPagerTransforms - 找到适合该库的分类,这里应该是animation。
在该分类下,按照以下格式添加该库的相关信息。
1. **ViewPagerTransforms** Library containing common animations needed for transforming ViewPager scrolling for Android v13+.
[https://github.com/ToxicBakery/ViewPagerTransforms](https://github.com/ToxicBakery/ViewPagerTransforms)
第一行,前面是标题,后面是简介。 标题和简介之间一个空格,简介之后,至少四个空格,然后回车。
第二行,项目链接地址。
简介一般来自项目主页的简介,也就是标题下面的那一句。
3.添加完成后,保存。通过git提交时,按照以下格式提交日志。
git commit -am "Add: 项目名称 by 项目作者名称"
统一收录
- 先在issues下创建一个问题
- 在问题下列出最近需要收录的Android库
- 累计到一定数量后,按照单一收录的方法逐个收录。