您可能正在犯的 7 个错误

开源项目最常犯的错误以及如何避免这些错误。
607 位读者喜欢这篇文章。
red pen editing mistakes

Opensource.com

启动一个新的开源项目可能很困难。您脑海中有一个很棒的想法,但将其转化为富有成效、健康、引人入胜的社区需要付出努力。可悲的是(似乎在几乎所有事情中都是如此),新项目一遍又一遍地犯着相同的错误。

以下是一些开源项目最常犯的错误,以及我关于如何避免这些错误的建议。

1. 光聊天不发布

在成千上万个启动的开源项目中,有太多项目在开始阶段就陷入困境,因为在 Slack 频道、邮件列表、问题或其他地方进行了一堆讨论。讨论在家中来回跳动,范围通常变得越来越大,以纳入许多不同的想法和考虑因素。

早期的开源原则——“尽早发布,经常发布”——对我们很有帮助。与其试图解决所有挑战,不如编写代码,将其放入仓库,然后开始接受拉取请求。当专注于代码时,您的项目将更快地发展、适应和改进。

2. 试图发布完美的第一个版本

领英创始人里德·霍夫曼曾说过一句名言:“如果你的第一个版本没有让你感到尴尬,那就说明你发布得太晚了。”

这在新开源项目中尤其如此。试图使您的第一个版本,甚至您的 1.0 版本尽可能完美是很诱人的。但事实是:大多数人不会注意到您的第一个版本,因此它真的不需要完美。

人们随着开源项目的演变而注意到、使用和参与其中。开始发布,获得反馈,进行改进,然后发布这些改进。这就是您建立增长的方式。

3. 试图构建完美的基础设施

我在新开源项目中看到的一个常见模式是,他们希望确保基础设施——网站、协作平台(例如 GitHub/GitLab)、持续集成和持续部署 (CI/CD) 以及所有其他内容——尽可能完美。这可能会导致项目创始人准备发布相当多的代码,但却对发布感到不安,因为他们担心其他不太完善的基础设施部分看起来有点蹩脚。

一个典型的例子是网站。一些项目会推迟发布,直到一个功能齐全、设计精良的网站到位。不要这样做。

专注于建立足够的基础设施,以便能够协作构建软件。发布您的软件,提高知名度——这将为您的社区带来增长。随着您建立增长,您将获得更多人手来帮助完善您的基础设施。

4. 不强制执行行为准则

近年来,多元化和包容性问题浮出水面。自然地,我们希望确保我们的社区是多元化和包容性的。无论这是否是正确的事情,多元化的社区都能带来更好的结果。

许多社区在启动时没有考虑他们希望看到什么样的行为。对于许多人来说,社区应该是快乐、有趣、引人入胜和包容的,这是理所当然的。

一些项目通过制定行为准则并将其发布在他们的网站上来正式化这一点。但这还不够。强制执行良好行为的方式是确保项目的领导者践行良好的行为。始终将不良行为事件扼杀在萌芽状态。不要只是试图忽视不良行为,因为它会恶化。同样,如果人们犯了错误,不要羞辱他们。通常,友好地私下说几句话,要求人们更加尊重就可以解决问题。

5. 失去焦点

我知道,我知道,现在这听起来像是工作,对吧?但说真的,虽然开源的主要乐趣之一是无限的创造潜力,但许多项目挣扎或关闭是因为他们将自己和他们的焦点分散得太薄。

不要试图成为所有人的所有事物。随着您的项目逐渐流行起来,会有来自热心用户的数百万个请求。保持专注于您的目标,但始终鼓励人们加入项目并扩展其焦点和潜力。

但重要的是,虽然“欢迎补丁!”是对愿望清单的常见回应,但不要只寻找补丁,还要寻找维护者。您最不想做的事情是为别人的工作维护技术债务。

6. 在太多地方进行太多讨论

我们周围有大量的沟通平台,例如 Slack、Mattermost、邮件列表、IRC、论坛、问题、视频会议等等。在所有这些地方都出现可能很诱人,以确保每个人都参与进来。这是一个错误。

正如我在关于沟通的喧嚣中讨论的那样,有不同类型的沟通渠道,我将其大致分为结构化和非结构化渠道。

我推荐以下准则

  • 所有错误和技术讨论都存在于 GitHub/GitLab 问题中
  • 在 Discourse 支持的论坛上建立一个通用的“社区俱乐部”
  • 建立一个实时聊天频道,人们可以在其中进行快速和非正式的讨论

每个频道都有不同的用途,并非所有频道都是必不可少的。问题是最重要的,其次是其他频道。

再次强调,保持专注并保持讨论相当集中,这将建立势头。

7. 太把自己当回事

最后,这一切都应该是为了乐趣。太多的项目有点太把自己当回事了。始终专注于享受乐趣,在社区成员之间建立良好的关系,并互相逗乐。

开源的结构建立在积极参与、具有创新精神的社区成员之上,他们具有将新想法付诸行动的创造力。始终保持这种敏捷和创新的精神。这将有助于您的项目蓬勃发展。

祝您好运,如果您对新项目应避免的错误有其他想法和建议,请在评论中分享。

User profile image.
Jono Bacon 是一位杰出的社区经理、演讲者、作家和播客主持人。他是 Jono Bacon Consulting 的创始人,该公司提供社区战略/执行、开发者工作流程和其他服务。他还曾担任 GitHub、Canonical、XPRIZE、OpenAdvantage 的社区主管,并为多家组织提供咨询和建议。

16 条评论

我喜欢阅读您的生产力技巧。
感谢您的技巧。

这是我的一些看法

- 记录任务、里程碑、成就、反馈等。
- 跟踪在任务上花费的时间和资源

也在 README 中添加项目目标。似乎较大的项目有预定义的目标,可能是因为一些用户的拉取请求与维护者希望的方向不同。

回复 作者 Yigit Kocak

做得好。
关于您的第一个关于聊天的项目,可以通过尽早建立某种关于项目的想法、计划和范围的信息库来部分解决。随着它的发展,这也必须发展,但它可以帮助控制一个变得过于广泛和不够深入的项目,使其对用户没有意义。
此外,这个信息库可以成为第一个文档的核心,以便尽早开始,您就可以以连贯的方式向用户和可能的未来贡献者解释项目的意义。

后续文章的思维实验:对于新项目,哪个文档更重要,首先关注:路线图和“这个很酷的东西将如何修复您的窗口小部件!” 使用文档,还是技术文档、清晰的构建脚本以及吸引潜在贡献者的东西?

例如,您如何考虑改进用户体验,与改进新项目入门的开发者体验?

如果您也写那篇文章,请告诉我 - 如果没有,我需要思考一下!

回复 作者 Greg P

我认为,尽可能早地,对文档的支持和创建应该成为项目 DNA 的一部分。开始得越早,您就能更好地防止文档小山变成大山。还有一个反馈循环,通过创建文档可能会最终揭示一些需要在代码中以某种方式处理的操作上的不合逻辑之处。

回复 作者 Shane Curcuru

这非常及时。就在昨天,我向 OpenNMS 团队发送了一条关于整合我们的一些沟通渠道的说明。

对于代码,它运作良好:我们在 github 上管理我们的代码,并使用 Jira 管理问题。对于“实时”通信,我们过去使用 IRC,但现在已转移到 mattermost 实例 (chat.opennms.com) 与 IRC 网关,因此这已涵盖。

但我们仍然有邮件列表和一个名为 Ask OpenNMS 的在线论坛。列表托管在 Sourceforge,我建议我们将所有内容都移至论坛。您可以配置论坛在添加内容时通过电子邮件通知您,但我知道会有人抵制放弃邮件列表。

好点子。关键问题:您认为每个沟通渠道用于什么任务?同样重要的是:哪些类型的人使用每个沟通渠道?

Apache 项目默认使用邮件列表(从我们的历史来看),这对于积极参与代码开发的开发人员来说是有效的。一些较大的项目有论坛 - 用于最终用户问题、配置以及如何作为一个整体使用产品。

了解不同类型的对话是否集中 - 或者也许尝试首先移动一组对话(可能是开发人员/代码构建对话)可能会有所帮助。

回复 作者 Sortova

我最近读到的一篇文章指出,“它会扩展吗?” 是一个糟糕的问题,不应该在项目的早期提出。您应该使用现在能用的最快编写的愚蠢算法。如果您的项目很好,将会有一个 2.0 版本,您可以在其中用树替换该链表。或者对您的数据库进行分片。随便什么。但是,如果您在发布 1.0 之前尝试在二十个不同的方向上扩展,您将无法发布。

#2(试图发布完美的第一个版本)是我大部分项目被毁的原因 :(

#2 和 #3 都是工程师的症状:它还没有准备好,我不想在它完美之前发布!如果您想发展一个开源项目,您*具体*如何定义增长?

您想要培养的是贡献者的增长。而不是代码。因此,“尽早发布,经常发布”至关重要,因为新人通常会从下载*发布版本*开始,然后 - 如果他们有兴趣 - 开始查看代码。

大多数人对外面的代码不感兴趣。他们感兴趣的是它为他们解决什么问题。拥有发布版本 - 即使是不完整的 - 是新人开始了解您的项目是否(对他们!)有趣的方式。

还有

错误 #0:没有 LICENSE,最好是众所周知的 LICENSE(MIT、Apache、GPL)。

错误 #... 嗯,没有数字来表示这个,它是一个名称:没有一个好的 README。一个真正告诉人们您的代码做什么、如何使用它以及如何贡献的 README(或指向每个的*明显*指针!)。

嗯,是的,Jono,文章很棒,但是还有很多数字要添加到其中!

2 & 3 IDK...

我理解为什么完美主义不好,而且我离完美主义很远(不断学习意味着你不可能完美主义,因为明天你会学到更多需要考虑的东西)。

我觉得基础设施或质量不足会造成损害。我认为另外一个非常糟糕的事情是以盈利为主要驱动力的开源(或闭源)开发。我认为这会比高标准更快地扼杀大多数项目。

很棒的文章,我认为它简洁地表达了许多常见的缺陷。发布版本很困难,你想要发布优秀、稳定的版本,并包含所有功能,但它们需要定期发布。我同意如果你对你的第一个版本没有(至少一点)感到尴尬,那么在展示足够的希望之间取得平衡是很困难的。这些年来我学会了更加放松。

近年来,随着期望的提高,基础设施建设变得更糟。我认为这是一件好事,但它必须与实际发布东西、向前发展相平衡。而且我认为还应该确保你没有在基础设施上投入过多资源,以至于损害了新功能的发布。

写得不错,感谢整理这篇文章!

实际上,“强制执行行为准则”是一个错误,它会将我们引向思想意识的回音室,在那里思想的多样性受到压制。这可能是你可能犯的最大错误。谷歌是这种行为最新的例子,他们的业务正因此受到影响。而且这并不是像埃里克·S·雷蒙德这样的人多年来没有对这种现象发出警告。

© . All rights reserved.