你可能正在犯的 7 个错误

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

Opensource.com

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

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

1. 光说不做

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

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

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

LinkedIn 的创始人 Reid Hoffman 曾经说过一句名言:“如果你没有对你的产品的第一个版本感到尴尬,那么你发布得太晚了。”

这在新开源项目中尤其如此。试图使你的第一个版本,甚至 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...

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

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

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

近年来,基础设施建设变得更糟,因为期望值上升了。我认为这是一件好事,但它必须与实际发布东西、向前迈进相权衡,而且我想说还要确保你没有在基础设施上投入太多资源,而损害了新功能的发布。

写得很好,感谢你整理这篇文章!

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

知识共享许可协议本作品根据知识共享署名-相同方式共享 4.0 国际许可协议获得许可。
© . All rights reserved.