Skip to content
Trinea edited this page May 10, 2014 · 30 revisions

##内容添加及编辑规范 English Version: Specification of adding and editing content
整理一下添加新内容的规范,维持一个统一的格式,方便其他朋友添加以及后续做其他事。

###1、分类标识
大分类用##标记,如目前的个性化控件大分类
小分类用####标记,如个性化控件中的ListView小分类
所有项目或个人或组织都用1.开头,因为markdown会自动递增做为序号

###2、项目内容写法
第一行是1.加上项目的项目名,所有项目都是1.,因为markdown会自动递增做为序号
第二行是项目的功能介绍
第三行是项目地址:+ url
以上三行是必须的。后面可选行如下:

示例APK地址:Demo地址:+url
示例项目地址:Demo项目地址:+url
效果图:效果图:+![Renderings](url)
文档或API介绍地址:文档介绍:+url
官网地址:官网网址:+url
APP示例:APP示例:+文字,表示哪些App用到这个项目或是有类似效果。
在线演示地址:在线演示:+url

项目内容写法示例:

1. Android Auto Scroll ViewPager  
Android自动滚动轮播循环的ViewPager  
项目地址:https://github.com/Trinea/android-auto-scroll-view-pager  
Demo地址:https://play.google.com/store/apps/details?id=cn.trinea.android.demo  
Demo项目地址:https://github.com/Trinea/android-demo  
文档介绍:http://www.trinea.cn/android/auto-scroll-view-pager/  
效果图:![Renderings](http://farm3.staticflickr.com/2843/12805132475_e595664a81_o.gif) 

变更提交信息(Commit changes) Title格式:`Add projectName1, projectName2, projectName3` Desc可不写,写则格式: ``` markdown projectName1 desc1 projectName2 desc2 projectName3 desc3 ```

###3、个人及组织信息写法
第一行是1.加上个人或组织名,所有序号都是1.,因为markdown会自动递增做为序号
第二行是个人或组织信息介绍
第三行是Github地址:+ url
以上三行是必须的。后面可选行如下:

比较好的开源项目或产品;代表作:+文字
个人博客或组织主页地址:主页:+url
其他介绍:其他:+文字

个人及组织信息写法示例

1. JakeWharton  
就职于Square  
Github地址:https://github.com/JakeWharton  
代表作:ActionBarSherlock,Android-ViewPagerIndicator,Nine Old Androids,SwipeToDismissNOA,hugo,butterknife,Android-DirectionalViewPager, scalpel    
pidcat,另外对square及其他开源项目有很多贡献  
主页:http://jakewharton.com/  

变更提交信息(Commit changes) Title格式:`Add name1, name2, name3` Desc可不写,写则格式: ``` markdown name1 desc1 name2 desc2 name3 desc3 ```

###4、Commit changes
变更提交信息(Commit changes) Title格式:Add projectName1, projectName2, projectName3
Desc可不写,写则格式:

projectName1 desc1
projectName2 desc2
projectName3 desc3

PS:目前在不同语言版本的维护上还是手动的,大家有节省人力的好建议欢迎反馈给我 微博:[Trinea](https://weibo.com/trinea)    主页:[www.trinea.cn](http://www.trinea.cn/)    邮箱:[trinea.cn@gmail.com](mailto:trinea.cn@gmail.com)    QQ:[717763774](http://wpa.qq.com/msgrd?v=3&uin=717763774&site=qq&menu=yes)
Clone this wiki locally