Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 3.01 KB

CONTRIBUTING.md

File metadata and controls

61 lines (37 loc) · 3.01 KB

如何为 Aspoem 做贡献

欢迎使用 Aspoem ,现代化诗词学习网站。我们很高兴您为我们的项目做出贡献,无论您是报告错误、建议新功能还是贡献代码。本指南将帮助您开始以不同的方式为 Aspoem 做出贡献。

报告错误

在报告错误之前,请检查GitHub 存储库上的问题,看看该错误是否已被报告。如果有,您可以使用您拥有的任何其他信息向现有问题添加评论。

如果您在 Aspoem 中发现新错误,请在我们的 GitHub 存储库上提出问题。我们将尽力尽快解决该问题。报告错误时,请提供尽可能多的信息,包括:

  • 清晰且描述性的标题
  • 问题描述
  • 重现错误的步骤
  • 预期行为
  • 实际行为
  • 屏幕截图(如果适用)
  • 您的浏览器
  • 请为您发现的每个错误打开一个单独的问题。

维护人员将为您的问题应用适当的标签。

建议新功能

如果您对 Aspoem 的新功能有想法,请在我们的GitHub 存储库上打开一个新的讨论线程,与社区讨论您的想法。我们将尽力尽快回复您的建议。

在建议新功能时,请提供尽可能多的信息,包括:

  • 清晰且描述性的标题
  • 功能描述
  • 该功能将解决的问题
  • 任何相关的屏幕截图或模型
  • 任何相关链接或资源

贡献代码

如果您想向 Aspoem 贡献代码,您需要分叉该项目并提交拉取请求。如果这是您第一次为开源项目做出贡献,我们建议您阅读 GitHub 提供的关于如何为项目做出贡献的简短指南

我们将审核您的拉取请求并与您合作,将您的更改合并到项目中。

您的第一个代码贡献

我们维护了一个对首次贡献者有益的问题列表。good first issue 您可以通过在我们的GitHub 存储库中搜索标签来找到这些问题。这些问题的解决相对容易,我们很乐意帮助您入门。选择您感兴趣的问题,并对该问题发表评论,让我们知道您正在解决该问题。

本地运行

本地运行

代码审查

提交拉取请求后,项目维护人员将审核您的更改。我们可能会建议一些更改或改进。这是该过程的正常部分,非常感谢您的贡献!

贡献许可协议 (CLA)

与许多开源项目一样,我们要求贡献者签署贡献许可协议 (CLA),然后我们才能接受您的代码。当您第一次打开拉取请求时,机器人会自动添加带有 CLA 链接的评论。您可以通过点击链接并填写表格以电子方式签署 CLA。

寻求帮助

如果您对 Aspoem 有任何疑问,请随时通过以下渠道与我们联系: