github技巧_新GitHub项目的10个技巧

github技巧

GitHub已成为许多开源项目中相当重要的部分。 尽管许多人关注GitHub的代码托管方面，但该平台还包括用于问题管理，代码审查以及与许多其他工具和平台集成的综合功能。

但是，对于新的开源项目而言，开始并确保GitHub存储库处于最佳状态并准备吸引新的开发人员可能会有些不知所措。 为了使过渡顺利进行，这里有10个技巧，可帮助您完善octo项目并开始新项目。

1.设置许可文件

您应该做的第一件事是为您的项目选择一个许可证，并确保许可证文本位于LICENSE文件中。 不幸的是，GitHub上有太多项目缺少许可证，这使人们更难以使用和贡献代码。

如果您不确定要为项目选择哪种许可证，可以在线获取大量资源来选择最适合您的项目。

2.创建一个README.md

首次访问GitHub存储库时，README.md文件将呈现在代码下方。 这是一个绝佳的机会，可以介绍您的项目，说明如何构建代码以及说明人们如何参与和参与。 请记住，.md文件是Markdown文件 ，您可以使用Markdown语法使它们看起来像是puuuuty。 好吧，我承认，那太令人毛骨悚然了。

3.创建一个CONTRIBUTING.md

以类似的方式，CONTRIBUTING.md文件旨在显示人们如何参与GitHub存储库。 当该文件存在时，GitHub将显示一条小便条，邀请人们了解有关为您的项目做出贡献的更多信息。 单击该链接的用户将看到CONTRIBUTING.md的内容。

同样，这是一个很好的机会来解释人们如何参与。 在此文件中，您应该提供简单的分步说明，说明预期的社区成员如何克隆和构建代码，探索要处理的问题/功能，派生代码，贡献其更改以及他们可以用于哪些沟通渠道。帮助和支持。

4.将错误标记为“ Bitesize”

对于新的潜在贡献者而言，最困难的领域之一就是学习他们可以为项目提供帮助的内容。 当然，问题清单通常是一个很好的起点，但是许多问题充满了上下文和细微差别，这可能会使这一点变得困难。

一个简单的解决方案是创建一个Bitesize标签，您可以将其应用于对于初学者来说很简单的错误-这可能包括较小的UI问题，字符串问题，翻译修复等。 在对这些错误进行分类时，只需标记它们，然后在README.md和CONTRIBUTING.md文件中提供一个URL，即可将潜在的贡献者指向列表中以开始使用。

5.项目复选框

GitHub的一个小巧功能是可以使用Markdown在事件中添加复选框。 当您为较大的功能提出问题并需要完成许多任务时，这将很有帮助。 这意味着您无需为每个任务提交很多问题。 要简单地添加复选框，请使用以下语法： [ ]

整洁的是，当您在单个问题中添加多个这些复选框时，问题列表将在问题标题旁边显示已完成的检查项目数。 这提供了一种方便的方法来确定哪些较大的问题正在取得进展，哪些没有取得进展。

6.问题模板

说到问题，管理错误最令人沮丧的方面之一就是用户提交的错误对开发人员的解决没有特别帮助。 通常，您希望用户提供以下信息：

• 该问题的简要描述
• 更详细的描述会发生什么以及为什么不起作用
• 预期结果以及电流不正确的原因
• 逐步的指令集说明了开发人员如何重现该问题。
• 有关用户系统的详细信息列表（例如，操作系统，软件版本以及任何其他详细信息）

这是典型用户要提供的很多信息。 为了简化操作，GitHub具有问题模板功能，您可以在其中使用用户应填写的内容和问题预先填写新问题。只需在代码中的.github目录中创建ISSUE_TEMPLATE.md文件，然后在其中添加Markdown该文件，它将显示在新发行版的主文本框中。 您可以使用PULL_REQUEST_TEMPLATE.md对拉取请求执行相同的操作。

7.使用维基

建立强大社区的最重要方面之一是确保新参与者可以学习如何参与。 理想情况下，您希望提供有关您的项目的文档，例如：

• 有关如何存储代码，使用新功能以及代码审查过程如何工作的分步教程。
• 编码标准，约定和要求。
• 代码明细，结构和不同源文件的功能。
• 有关项目沟通方式，决策方式等的详细信息。

每个GitHub项目都有一个内置的Wiki，是此类内容的理想之地。 而且，每个Wiki实际上都是可以提交的存储库。 这样可以很容易地在各贡献者之间分配负载，以维护有关该项目以及如何参与的文档。

8.建立一个GitHub页面站点

尽管Wiki是记录文档的好地方，但它并不是有关您的项目的网站的最佳选择。 为此，GitHub提供了GitHub Pages —用于构建项目网站的免费服务。

GitHub Pages由静态内容管理系统Jekyll支持。 这使得构建站点，在回购中对其进行维护以及对其进行迭代和改进变得很简单。

9. Waffle.io/ZenHub进行规划

GitHub当前不包括特别全面的项目管理工具。 如果要构建项目并希望管理目标截止日期并为这些截止日期分配任务和功能目标，则可能需要一个项目管理系统。 幸运的是，有一些不错的选择，它们都与GitHub紧密集成：

• ZenHub是一个特别全面的项目管理系统，您可以在其中跟踪工作板，任务和TODO项目，所有这些都通过问题和其他功能与现有GitHub项目集成。 ZenHub整合得非常好，并添加了一层功能，而GitHub中显然缺少该功能。
• Waffle是一个类似于Trello的平台，可让您管理与GitHub问题完全集成的任务的看板卡。

我建议您同时尝试一下，看看哪种最适合您。

10.使用Travis CI进行持续集成

持续集成已成为构建现代软件的核心部分。 CI的基本要旨是，开发人员应定期提交回购协议，自动化系统应定期使用生产工具构建代码并报告构建失败或通过的情况。 这减少了开发人员处理难以着陆并可能引入错误的大型功能的可能性。

Travis CI为此提供了一个非常简单的解决方案。 您只需使用GitHub帐户登录，告诉Travis CI您要构建的内容，就可以查看报告。 您甚至可以将Travis CI与Heroku和Slack集成。

因此，我们有了它：10个GitHub技巧可帮助您开始新的GitHub项目。 请确保在评论中告诉我们您自己的提示和技巧。

翻译自: https://opensource.com/business/16/6/10-tips-new-github-projects

github技巧