开源分享指南精华 | AI生成和翻译

Home 2026.02 English 中文

---

Question: 如何变得更加 Open Source？在 Open Source 项目、博客等内容中，我们可以公开分享哪些文件和信息？

Answer:

变得“更加 Open Source”意味着养成一种优先考虑透明度、协作、社区以及公开分享知识/代码的习惯、流程和心态。无论你是个人开发者、小团队还是公司，这都适用。

针对个人开发者或小团队

• 定期贡献已有的 Open Source 项目（修复 Bug、添加特性、改进 Docs、Review PRs）。
• 开源你自己的代码 —— 从 GitHub/GitLab 上的小型 Utilities、Configs 或学习项目开始。
• 进行公开写作 —— 维护一个 Dev Blog，在 Medium/Dev.to 或你自己的网站上分享 TILs (Today I Learned)、Architecture Decisions、Post-mortems 或 Tutorials。
• 工作透明化 —— 即使是对于个人/侧边项目，也使用公共 Issue Trackers，并公开讨论设计方案。
• 日常采用开放实践 —— 使用 OSI 认证的 Licenses，编写规范的 Commit Messages，快速响应 Issues。
• Build in Public —— 在 X (Twitter)、Mastodon、LinkedIn 或你的博客上分享进度更新、Roadmaps 和决策。

针对希望变得更加 Open Source 的公司/团队

• 制定 Open Source 战略 —— 记录目标（学习、招聘、生态系统影响力、创新速度等）。
• 开始开源内部工具 —— 从非核心/低风险的 Libraries、Configs 或 CLIs 开始（先进行清理：删除 Secrets 和敏感逻辑）。
• 允许并鼓励 Upstream 贡献 —— 确保员工在工作时间内参与外部项目贡献在流程和法律上是简便可行的。
• 投资于 Documentation 和社区 —— 将 Docs 视为一等公民（许多成功的 OSS 公司都是通过优秀的 Docs 获胜的）。
• 在内部采用开放流程 —— 使用公开的 RFCs、公开的 Roadmaps（可行时）以及针对产品特性的公开 Issue Trackers。
• 从社区招聘/奖励社区 —— 认可 Maintainers，提供演讲机会，赞助活动，聘请活跃的 Contributors。
• 发布关于 OSS 的公司博客 —— 撰写关于 Architecture、Scaling Stories、Open Source 经验教训、Security 实践等内容。

Open Source 项目中推荐公开分享的核心文件和信息

以下是 Git Repository 根目录下的标准推荐文件：

• README.md (最重要的文件) 项目名称、一段话简介、存在意义、快速启动/安装说明、用法示例、Screenshots/GIFs、状态（Stable/Experimental）、License 链接、贡献指南。

• LICENSE (或 LICENSE.txt / LICENSE.md) 实际的协议文本（MIT, Apache 2.0, GPL, BSD, MPL 等）。选择一个 OSI 批准的 License。没有这个文件，项目就不是 Open Source。

• CONTRIBUTING.md 如何贡献：设置开发环境、Coding Style、Commit Message 格式、如何提交 Issues/PRs、对 Maintainers 的预期、Slack/Discord/Forum 链接。

• CODE_OF_CONDUCT.md 通常使用 Contributor Covenant —— 有助于营造一个友好、无骚扰的环境。

其他非常常见/强烈推荐的文件：

• SECURITY.md —— 如何报告安全问题（私密邮箱/安全政策链接）。
• CHANGELOG.md 或 RELEASE_NOTES.md —— 遵循 Keep a Changelog 格式。
• .github/ 文件夹，包含：
  • ISSUE_TEMPLATE/** —— Issue 模板
  • PULL_REQUEST_TEMPLATE.md
  • dependabot.yml / funding.yml / workflows/
• ROADMAP.md 或 GitHub Project Board —— 未来计划，有助于吸引贡献者。
• docs/ 文件夹 —— 详细文档、architecture.md、api.md、tutorials。

还有哪些可以公开分享的内容（在博客/网站/社交媒体上）

• 架构图和决策（ADRs — Architecture Decision Records）
• Performance Benchmarks 和对比
• 内部工具（CLI Helpers, Git Hooks, CI Pipelines —— 需脱敏）
• 失败的故事 / Post-mortems
• 扩容故事 / “我们如何处理数百万次请求”
• 公开的 RFCs / 设计提案
• 员工的学习心得 / 技术会议演讲 Slides
• 贡献者亮点介绍 / 感谢信

从点滴做起：挑选一个项目 → 添加 README + LICENSE + CONTRIBUTING → 分享它 → 根据反馈进行迭代。

References:

• Starting an Open Source Project (opensource.guide)
• How to Write a Good README (freeCodeCamp)
• Setting an Open Source Strategy (Linux Foundation)
• Improve Your Open Source Development Impact (TODO Group)
• Keep a Changelog
• Contributor Covenant

---

Back Donate