跳转至

冲刺指南

欢迎参加BeeWare冲刺活动!

欢迎!很高兴您决定加入我们!如果您还没有向蜜蜂团队的成员自我介绍,请尽快这样做。一旦您完成了自我介绍,请返回这里开始您的工作。

什么是冲刺?

冲刺是一个非结构化的机会,可以花几个小时或几天的时间在开源项目上协作工作。它们通常与会议相关联;会议之后的冲刺阶段提供了一个机会,可以将会议带来的能量、热情和兴趣转化为对我们日常使用软件的改进。

冲刺也是向人们介绍如何为项目做出贡献的机会。我们希望您能在冲刺时获得极大的乐趣,大到您回家后会继续贡献!

无论你有多少经验都无关紧要。在过去的冲刺中,我们整合了来自不同经验层次的贡献——高中生、刚毕业的编程训练营学员、自认非程序员的人,以及经验丰富的开发者。无论你的经验水平如何——我们都能找到让你贡献力量的方式。

代码也不是您做出贡献的唯一方式。像 BeeWare 这样的项目需要的不仅仅是代码–我们需要有人来撰写、校对和翻译文档;我们需要有人来改进网页的设计;我们甚至需要有人来检查多年前报告过的错误,并确定它们是否已经被修复,也是一项宝贵的贡献。

最初的问题

首先,我们会问您几个问题,以便了解您的兴趣和经验。这将帮助我们找到您贡献的最佳方式。请仔细阅读这些问题,做好笔记,然后找到蜜蜂团队的成员,分享您的答案。如果您不理解问的问题,不用担心!让我们知道你所知道的,我们会一起从那里开始。

  1. 您之前用过BeeWare吗?

若尚未开始,请先完成BeeWare教程的学习。该教程将为您介绍BeeWare项目的基本概念,以及项目各组件如何协同工作。若在完成教程过程中遇到任何问题,请做好记录——确保他人不再遭遇相同问题,正是您首次贡献的绝佳切入点!

完成教程至少到第4步后,请继续进行下一个问题。

  1. 你随身携带了哪些计算设备?

您随身携带的设备会对您能参与的工作内容形成实际限制。例如,若您使用的是Windows笔记本电脑,则无法处理任何与iOS相关的工作。您的笔记本电脑运行的是Windows、macOS、Linux还是其他系统?您的手机是iOS设备还是Android设备?这些设备是由雇主提供还是您个人自备的?

  1. 你拥有多少编写Python代码的经验?

你是编程新手吗?Python老手?还是编程老手才刚开始学Python?或是刚从编程训练营毕业的新人?我们想为你匹配一个与你的经验水平相称的项目。

  1. 您熟悉 GitHub 的贡献流程吗?

你是否使用 GitHub(或其他类似代码共享平台)托管自己的代码或参与他人项目?你是否了解持续集成(CI)的概念?你是否参与过使用提交前钩子的项目?如果我要求你"将你的 PR 与主分支进行 rebase 操作",你会明白该怎么做吗?

  1. 你之前参与过开源项目吗?

你过去参加过冲刺会议吗?你是否曾向开源项目提交过拉取请求?你熟悉如何使用GitHub创建拉取请求吗?

  1. 你还有其他可能派上用场的特殊技能吗?

你是否熟悉图形用户界面API(如WinForms、Cocoa或GTK)?你是否对特定操作系统的内部机制有深入了解?你是否精通除Python之外的编程语言?即使你没有特殊技能也无妨——但若我们团队中恰好有Windows专家,我们希望确保这些技能得到充分运用。

  1. 你为什么加入我们,对什么感兴趣?

"听起来是个友好的项目"完全是个不错的回答。不过,若您今天加入我们还有其他原因,请告诉我们。您对移动端或桌面端开发感兴趣吗?打包?网站?控制台应用?若您没有特定偏好——根据您目前对BeeWare的了解,什么最吸引您?

现在,找一位蜜蜂团队成员来分享您的答案。他们可能会问您一些后续问题;但随后,他们会给你指出你应该能够做出贡献的方向。

查找您的问题

若您曾与Bee团队成员交流过,他们很可能已为您指明BeeWare项目中可参与贡献的领域;甚至可能推荐了具体的问题供您处理。若未指定具体问题,他们大概会引导您查看该项目的"新手友好问题"。这意味着什么呢?

GitHub 提供的问题列表可让 BeeWare(及其他项目)跟踪所有已报告的问题。这包括明确的错误、可能是错误的意外行为、对新功能的请求、对更多文档的请求–任何可以改进 BeeWare 的方法。随着新问题的报告,蜜蜂团队会将其中的一些问题标记为非常适合首次贡献者的问题。这些问题并不要求立即解决,但定义明确或易于重现,并且很可能 对根本原因有很好的线索。这些问题被标记为 “good first issue” 标签,以方便查找。

要按“好初始问题”标签筛选 GitHub 问题列表,请按以下步骤操作:

  1. 点击问题列表上方的“标签”按钮以激活下拉菜单。
  2. 在下拉菜单顶部的搜索框中输入单词"good"。
  3. 在筛选列表中点击"好首期"。

按标签筛选 GitHub 问题

通过"新手友好问题"标签筛选GitHub问题。

找到感兴趣的问题后,阅读帖子上的评论,并在讨论中发表评论,说明您正在研究这个问题(例如,“Looking into this at the PyCon US 2025 sprints”)。BeeWare 不会明确“分配”问题 - 我们接受任何人的贡献。但是,在冲刺时,我们需要确保不会出现两个人同时处理同一个问题的情况。留下评论是在贡献者之间进行协调的一种轻量级方法。

如果您仍然找不到您想做的事情,请联系蜜蜂团队的成员,他们会帮助您缩小范围,找到具体问题。

搭建开发环境

发现问题后,您需要设置开发环境,以便修复问题。每个 BeeWare 项目都有自己的贡献指南:

如果项目不在此列表中,请查看项目 README,了解如何配置的详细信息。如果有任何说明不合理(或找不到相关说明),请联系蜜蜂团队的成员,他们会帮您解决困难。如果您认为可以改进指南,使其他人不会遇到同样的问题,那么改进贡献指南也是一项宝贵的贡献!

现在,您可以开始解决您的问题了!

提交永久居留申请后会发生什么?

一旦您提交了拉取请求,并且拉取请求通过了所有自动检查后,您就可以请求审核了。让核心团队中的一位成员知道您的 PR 已准备好接受审核,然后他们就会来看看。

如果这是您的第一个 PR (拉取请求),审查时我们很可能会发现一些问题。这可能是你没有考虑到的边缘情况,也可能是你没有遵循的代码约定。不要气馁!没有人第一次就能 100% 正确地完成 PR。

一旦PR通过审核,您的审核者就会合并PR——至此大功告成!恭喜您——您已为BeeWare贡献力量!若这是您首次为BeeWare贡献代码,您还将获得一枚BeeWare挑战纪念币——找到核心团队成员,他们会为您颁发纪念币!

救命!我卡住了!

如果您在途中遇到困难,请联系蜜蜂团队的成员。不要害怕提出任何问题。如果您遇到困难,我们希望让您摆脱困境。如果您感到困惑,那是因为主题复杂,而我们还没有解释清楚。我们渴望帮助–我们希望确保您有一个成功的冲刺。

如果我在冲刺期间未能完成我的贡献怎么办?

没问题!您全年都可以提交贡献。冲刺的目的之一也是为了鼓励您在一年的其他时间继续作出贡献,且让您有能力这样做。蜜蜂团队将可以在这整个过程中提供任何您所需要的帮助。

若您正在处理GitHub问题或已提交PR,可继续通过GitHub进行沟通。如有其他疑问或需要实时协助,最便捷的联系方式是加入BeeWare Discord服务器。我们期待与您继续合作!

改进本指南

如果您对如何改进本冲刺指南有任何建议,请告诉我们。哪些方法对你有用?哪些没有?我们能做得更好吗?请记住:解决关于此冲刺指南的问题也算是对 BeeWare 的贡献!