你可能正在犯的 7 个错误

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

Opensource.com

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

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

1. 光说不做

在数千个启动的开源项目中,太多的项目因为在 Slack 频道、邮件列表、问题或其他地方的大量讨论而停滞不前。讨论不断地进行,范围也经常变得越来越大,以纳入各种各样的想法和考虑因素。

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

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

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

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

我很喜欢阅读你的效率提示。
谢谢你的提示。

以下是我的 2 美分

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

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

回复 作者 Yigit Kocak

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

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

例如,你如何考虑改善用户体验与改善新项目起步时的开发者体验?

如果你也写了那篇文章,请告诉我 - 如果没有,我需要仔细考虑一下!

回复 作者 Greg P

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

回复 作者 Shane Curcuru

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

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

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

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

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

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

回复 作者 Sortova

最近我读到一篇文章指出,“它能扩展吗?” 是一个糟糕的问题,不应该在项目的早期阶段提出。你应该使用最快编写的、能暂时应付的愚蠢算法。如果你的项目足够好,将会有一个 2.0 版本,你可以在其中用树替换链表。或者对你的数据库进行分片。无论如何。但是,如果你在发布 1.0 版本之前就试图在二十个不同的方向上进行扩展,你就不会发布任何东西。

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

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

你想要培养的是贡献者的增长。而不是代码。所以“尽早发布,频繁发布”至关重要,因为新手通常会从下载一个*发布版本*开始,然后 - 如果他们感兴趣 - 开始查看代码。

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

还有

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

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

嗯,是的,乔诺,文章很棒,但是还有很多数字要添加到里面!

2 & 3 我不太清楚...

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

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

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

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

很好的总结,谢谢你整理这些!

实际上,“强制执行行为准则”是一个错误,它导致我们进入思想的回音室,在那里思想的多样性受到压制。这可能是你能犯的最大错误。谷歌就是这种行为的最新例子,他们的业务因此受到影响。而且我们也不是没有像 Eric S. Raymond 这样的人多年来对这种现象发出警告。

Creative Commons License本作品采用知识共享署名-相同方式共享 4.0 国际许可协议进行许可。
© . All rights reserved.