00.代码贡献指南 - XFY9326/Schedule Wiki

代码贡献指南

如果您想要为自己的学校增加适配,或者希望能够为本项目提供其他方面的代码贡献,请仔细阅读本指南

操作步骤

  1. Fork项目到自己的账户中
  2. 对develop分支的代码进行修改【课程适配等】
  3. Pull最新的develop分支内容到本地【合并可能的新的commit】
  4. 测试添加功能是否正常
  5. Push到Fork的项目中,并向本项目的develop分支提交Pull request
  6. 等待维护者的代码检查与审查
  7. 代码成功合并后,将在下次的版本更新中合并入master分支

注意事项

  1. 维护者将不会测试适配代码的可用性
  2. 版本发布不定期,因此需要等待【可以商量】
  3. 请只对develop分支进行修改
  4. 请注意代码质量与可读性,差的代码将可能面临拒绝合并
  5. 请在commit与Pull request中注明代码更改的目的
  6. 有任何问题或建议可以直接发邮件或者提交issue
  7. 请在消除所有Warning之后提交代码【使用默认的Lint】
  8. 如果直接使用注解取消Warning,请注明原因

自定义发行版

由于本项目完全开源,所以只要在遵守GPL协议的情况下,就可以自行发布自定义的发行版
但是请不要以任何原作者,维护者,Pure课程表等本项目的名义进行宣传
自定义的发行版请修改APP图标,APP名称,与APP包名!!!

JS课程适配

由于此部分采用插件的方式进行管理,因此并不需要对项目代码进行修改
请在确保代码合法,不侵犯用户隐私的前提下将配置文件分享给需要的用户
本项目将不会承担使用任何JS插件带来的任何责任

维护

本项目代码不确保永远可用,是否继续维护将取决于维护者的个人时间
如果存在任何急需解决的问题,维护者无必要一定修复任何bug或添加任何新功能

其它

有任何不明确的问题可以提issue或发邮件向我询问