对加载的标题表示歉意。这是对 Twitter 操作文章的致敬,这些文章教会了我们设置头像、撰写诙谐的个人简介、设置地点、吸引受众以及增加价值的好处。作为一个每周挖掘大量开源项目的团队(因此您不必这样做),我们已经了解了一些围绕您的代码构建社区的具体方法。这是我们为推广开源项目可以做的十大事情的列表,或者是我不分叉您的项目的十个原因。

1. 你连一份该死的自述文件都没有

对于很多项目,尤其是托管在GitHub上的项目,自述文件通常是人们第一次看到您的项目。Tom Preston-Warner说自述文件非常重要,您应该先写它。我已经开始在最近的项目中这样做,并发现它可以集中我的思维并帮助我向其他人传达项目目标。GitHubMarkdownTextileRDoc等的支持意味着格式丰富自述文件可以包含链接、表格和代码片段。

那么什么才是好的自述文件呢?以下是您应该考虑的一些关键事项:

  • 描述- 我很惊讶有多少次我登陆了一个显然很受欢迎的项目页面(因为 Twitter 告诉我的),但我不知道为什么,因为项目所有者没有明确告诉我该项目是什么或为什么我应该关心。
  • 安装说明- 告诉我在哪里可以获得这些位以及如何安装它们
  • 从哪里获得帮助- 链接到文档、邮件列表、wiki 等。
  • 贡献指南- 告诉我如何提供帮助,包括所需的功能和代码标准
  • 贡献者列表- 列出项目背后的人员
  • 学分、灵感、替代方案- 告诉我这是否是另一个项目的分支或受到其他项目的启发。当我以后知道的时候,我不会认为你是个混蛋。

2. 没有包含测试、规格、功能、示例

没有测试的项目更难信任、更难贡献,而且看起来更像是一个业余黑客。但更重要的是,测试减少了支持请求。我不必问你或谷歌,我可以查看 codez包含基于场景的代码的示例文件夹向我展示而不是告诉我。

3.您没有项目主页

尽管 GitHub 的项目页面很好,但它们在 SEO 和品牌推广方面却很糟糕。创建一个引人注目的 项目主页。GitHub Pages功能使创建具有自定义域支持的简单项目主页变得非常简单。

4.你需要设计帮助

如果您没有像素风,请找到一位有像素风的设计师,并与他们付费、交易或易货,为您的项目提供有吸引力的品牌和风格。远离竞赛和其他“众包”网站。对规范工作说不,因为您不想为希望您的代码被“选择”的人编写项目。

5.您没有域名

一个漂亮的主页固然不错,但为什么不花十美元让人们更容易找到它呢?如果.com不适用于您的项目名称,请尝试使用Domai.nr等服务来寻找创意替代方案。我们使用 Domai.nr 来查找我们的短域名。

6.您没有 Twitter 帐户

您可能已经在使用 Twitter 来宣传您的项目,但是您是否考虑过建立一个专门的项目帐户?Erik Michaels-Ober创造性地获取了Ruby Twitter Gem 的 @gem 用户名,我们可以通过该用户名发布更新并回答支持问题Modernizr、 @ mongodb和 @ octokit是其他示例。即使您不是项目所有者,也许您也可以创建一个非官方帐户来帮助宣传该项目,就像Trevor Burnham对 @ CoffeeScript所做的那样。

7. 您的许可不明确

仅仅因为代码在线发布并不意味着它可以免费进入公共领域。为了使用您的代码,我需要知道这样做的规定。通过在自述文件中包含许可证文件或部分,可以让我轻松了解使用它的条款。

8.你不联系我

Twitter 让你可以轻松地关注你所在领域的人,但也许更强大的功能是关注某个主题的能力。搜索并关注与您的项目相关的主题标签。寻找对您的项目旨在解决的问题提出问题或表达沮丧的人。Chris Eppstein和我经常与有#CSS3问题的人联系,并赞扬Compass 的 CSS3 模块的好处。

如果您的项目足够大,请考虑创建您自己的 IRC 频道#node.js#redis是活跃的、以项目为中心的渠道的绝佳示例。

9. 你不会在会议和聚会上谈论你的项目

没有什么比六英寸高的舞台和挂绳更能给人一种专业的错觉了。如果您想吸引潜在用户和贡献者的注意,请向技术社区的会议或聚会提交演讲。如果您没有被接受,无论如何都要去组织一次简单的会议,您可以在其中与用户亲自会面,回答问题并获得反馈。

10.您没有将其提交到变更日志新闻

如果您想向世界展示您新的开源代码热度,最好的场所之一就是这个网站。我们努力保持在开源领域的最前沿,但我们无法找到一切。想宣布您的新项目吗?提交[就在这里](https://changelog.com/news/submit)。

到你了

现在轮到你了。我们想知道是什么让您关注并参与开源项目。请通过《黑客新闻》告诉我们。

我不会使用你们的开源项目的十大原因