为什么投稿指南很重要。

太长不看

作为开源项目的维护者，你应该格外关注开发者体验。README.md文件必须清晰明了、信息丰富，这一点无需赘述。大家都知道优秀的文档能如何提升项目的价值。而一份高质量的CONTRIBUTING.md文件则是留住开源贡献者的关键所在。

CONTRIBUTING.md 文件不应与教程或项目指南混淆，它是reference material为想要了解有哪些工作机会以及如何快速参与的开发人员准备的。

请确保您的准则符合以下要求：

• 清晰且可操作
• 使用精准的语言
• 易于快速浏览
• 指向其他资源

哦，对了

Glasskube已于二月正式发布，我们的目标是成为 Kubernetes 包管理的首选默认解决方案。我们深知这绝非易事，但有了您的支持，我们一定能够实现目标。
表达支持的最佳方式就是在 GitHub 上给我们点个星⭐

了解你的受众

开发者并非铁板一块的互联网群体，他们并非都关心同样的问题，拥有相同的经历，或者以相同的方式工作。话虽如此，有些东西确实具有普遍适用性。他们希望少读书，多实践。🏗️

开发者都希望尽快上手，项目维护者有责任尽可能地消除障碍，使之能够顺利进行。

如何缩短开发者发现你的项目到提交第一个 PR 之间的时间？

首先，贡献者需要找到一个可以着手解决的问题。请确保准备好已标记的待解决问题，以便所有潜在的贡献者都能找到。如果初级开发者想通过你的项目学习一门新语言，请确保这些问题good first issues易于查找。如果更有抱负的资深开发者准备做出贡献，请明确告知他们希望他们关注哪些问题，并引导他们查看当前的里程碑或 GitHub项目。

定义贡献路径

明确有哪些贡献路径可供选择。项目的哪些方面需要帮助？利用 GitHub 标签对项目的各个领域进行划分。在我们的案例中，项目包含不同的组件，例如项目管理GUI、项目CLI开发Package Controller、项目管理Docs、UI项目管理以及代码仓库本身。

社区参与

好的，贡献者已经了解了项目中存在各种复杂程度不同的未解决问题，也明白自己可以贡献哪些方面的工作。那么，他们该如何表明自己已准备好为项目做贡献呢？如果他们还有其他问题该怎么办？请明确告知他们你希望他们通过 GitHub、 Discord还是 Slack
与你沟通。

尽量不要将沟通局限于 GitHub 问题本身。对许多开源贡献者来说，乐趣在于结识志同道合的人，共同协作和分享。当然，并非所有人都希望如此，但务必邀请贡献者加入社区，因为他们目前还不是社区的一份子。

贡献工作流程

贡献者指南中最重要的部分之一，或许就是为贡献者提供以下问题的清晰说明和答案。

详细介绍贡献代码更改的步骤：🪜

• 议题选择与分配。
• fork 仓库。
• 分支、编码和提交约定。
• 提交拉取请求并进行审核。
• 处理反馈和迭代。
• 将贡献合并到主代码库中。
• 探讨提交信息的最佳实践，并保持分支的更新。

开发指南

每个开源项目都旨在解决不同的问题，并基于特定的技术栈构建，而这些技术栈对某些贡献者来说可能是全新的。假设他们对你的工具一无所知，请详细解释项目的构建模块。

重点在于阐明代码库的构建方式、各个组件之间的集成方式以及部署环境。理想情况下，贡献者应该能够构建他们所贡献组件的本地版本并验证其工作。

如果在 PR 审核过程中才发现开发人员并不清楚这一点，这表明指南或协作流程可能需要改进。

测试

我必须强调提供清晰的说明的重要性testing code contributions。例如，Glasskube 运行在Kubernetes集群中，因此每位贡献者在提交 PR 之前都必须拥有本地测试的访问权限。虽然强制执行测试标准可能具有挑战性，但必须提醒贡献者，PR 审查不应该是发现功能问题的时刻。

文档和最佳实践

充分利用文档，如前所述，贡献者指南是旨在指导贡献者找到他们想要答案的参考资料。🔍

保持文件结构清晰very clear。大多数人浏览这类资料时只会快速浏览，直接寻找当时需要的内容。制定好浏览指南skimmable。

此外，可以肯定的是，有些贡献者永远不会访问您的 CONTRIBUTING.md 页面，即使访问了，他们停留的时间也有限。请提供一份简要说明（TL;DR），概括您希望贡献者记住的要点。同时，请将简要说明添加到 GitHub 代码库以外的其他地方。我已经将其添加到我们 Discord 服务器的 #help-forum 频道。

我很高兴你们的README.md文件写得非常棒，你们well-tagged issues也准备了充足的资源，欢迎尽可能多的贡献者加入。但是，为了维护和建立社区的信任，请务必把 CONTRIBUTING.md 文件也完善好。

为了理解CONTRIBUTING.md文件的价值，我觉得用餐厅来打个比方或许会有帮助。🍝

💡 我们都曾被一家餐厅的菜单吸引，最终却因为其卓越的服务而再次光顾。同样，在开源项目领域，README.md 文件就像诱人的菜单，是最初的吸引力。然而，真正让开发者持续参与的，是 CONTRIBUTING.md 文件及其对整体开发者体验的提升。

如果您喜欢这类内容，并希望看到更多，请考虑在 GitHub 上给我们点个星标以示支持🙏