虽然杏是公共项目,但这不代表杏可以被任何人随意修改
要修改杏需要首先经过自己和负责人的审查和测试
杏具有一套工作流程,来完成代码编辑、查错、合并等流程
通过 Fork
创建一个分支,在此分支进行活动
通过克隆刚创建好的分支来获取代码
git init
git clone https://github.com/<用户名>/<分支名称>
随后在支持git、gradle的工作环境中打开此项目
这时杏会被工作环境自行加载、构建,接下来稍加等待即可
在对代码做出修改前,务必阅读 项目文档
合理使用项目中存在的库,避免重复造轮子或是错误使用一些库
尽量少修改 @Stable 注释的类或方法,这些内容已经是确认的稳定版本
尽量少修改 @Unsupported 注释的类或方法,除非你有把握解决各种问题
请在查错结束后对代码(类、方法)进行署名以及编辑简单Java Doc文档。
通过 Pull Request
将完成以上流程的分支推送到主分支
概述修改的内容即可,无需定位到具体的代码
在完成整个工作流程以后可以将分支删除
或不要再进行修改,直到下一次的工作流程需要时,将主分支拉取至此分支
当分支推送到主分支的代码存在一些bug,或是一些恶意修改时
往往会被负责人拒绝合并至主分支
当发生这一情况时,可以通过解释、沟通、修改的方式解决
一些时候可能是因为修改内容是多余的,或新增的功能是有争议或其他情况的
此时应当从社区获取建议以决定是否保留这些内容
当分支版本与主分支版本不一致时,导致合并出错
解决办法是拉取主分支的变更,然后修改冲突,额外进行一遍工作流程
若要加入杏的审查、测试工作,请看:官方工作流程