你可能正在犯的 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·雷蒙德这样的人多年来对这种现象发出警告。

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