贡献指引
XDYou项目的贡献指南
最近一次编辑:BenderBlog Rodriguez 2026-01-14
Traintime PDA / XDYou 是一个大众项目,虽然目前绝大多数代码都是我写的,我很想让各位从各个角度参与进来。
贡献前须知
- 光修改 README.MD、写简单文档的不计入贡献者名单。这类 PR 自本公告发布之日起不再接收。
不要用我的项目刷你们的课程实践报告! - 鼓励使用 AI 修改,添加新功能等。如果碰到小问题,也许就是你贡献的机会。
- 涉及黑产、恶俗/善雅、法律灰色地带、违反校规校纪、对大多数同学没有好处而仅对部分人有好处的 PR 概不接收。我也将尽可能地为学校数据安全贡献一份力,所以搞这些东西的不要让我知道。
- 任何贡献,只要能跑起来我就收,后续继续适配问题我来干。我同时很乐意教你们写代码。
- 贡献成功后,如果我在校外,我会给你们通过邮政挂号方式送感谢信。如果您担心隐私问题,请提前说明。
不懂过多开发技术的参与方向
如果您乐意帮忙,我可以给予你我能力范围内的最大可能帮助。我很乐意教你们。
- 英语国际化文件的优化。
- 提出各种合理的想法,并协助我实现。协助实现方式包括提供数据格式、提供数据来源等。
- 设计页面文件,纸质绘图也可以接受。希望能多写点注释性文字。
- 协助我进行 bug 修复。
目前程序我认证的贡献者有三十余个,大多数开发者均属于“不懂开发”的贡献者,背景各异。所以您如果有想法,请直接做吧。对于代码实现方面,PR 一般我都会先 Merge,然后融合的,所以不要有太大的负担。
希望大佬帮助我的东西
现在我基本上算工作了,平常很忙。希望大佬帮我看看下面的问题:
- 优化登录逻辑。
- 主页信息刷新逻辑。
- 优化程序的报错,减少不必要的弹窗。
- 使用合理,合法的方式获取到新的数据接口。
本程序原则上不接受任何新的接口。如果提供方可以提供通过浏览器 F12 方式得到的路径,则可以考虑。
不是西电的同志们如何利用代码?
以下是部分我觉得本程序中有通用价值的部分:
- /lib/page/classtable是本程序的课程表/日程表组件,您可以拿去用来渲染课表,这个表可以往里面塞考试信息等和课程时间不对应的玩意。
- 可以修改/lib/repository里面的东西,以用来适配您的学校相关系统。
- /lib/page/library是简单的图书馆页面,包括借书状况和查询书籍,可以修改一下成为某些课的大作业。
- /ios/ClasstableWidget是一个 iOS 下面简单的显示日程插件,可以按需使用。数据来源可以参考我是如何把东西存到程序公共空间的。
- /lib/page/public_widget有一堆不知所以的部件,看情况随便用。
在使用前,请看下文件的授权,以SPDX-License-Identifier开头。如果只有MPL-2.0而且你不方便开源仅对这一个文件的修改的话,和我联系。如果您是想将该软件适配到您学校,在绝大多数的可能范围内我可以给您部分功能代码的闭源许可。但需要注意的是,本人是反对通过学校基本服务来获取利润的,这样的商业化路子长久不了,而且有黑产之嫌。
计划写一个本代码的查看指南,请各位期待。在适配过程中有任何问题,请大胆地和我联系。