Ember 是一个开源项目,它的成功离不开志愿者的帮助。无论社区成员水平如何,我们都欢迎大家参与,无论是报告 Bug 还是完善文档。本指南将为您提供一些入门建议,并告诉您在想要参与时如何寻求帮助。预先感谢您的贡献!
贡献类型
任何旨在改善项目的变更都非常受欢迎!
您可以创建 Issue 来记录许多事情(以下列表并不详尽!):
- Bug
- 改进建议
- 代码质量(例如重构)
- 完善文档(阐明内容、改写语句、提供更多示例、修正拼写错误、添加缺失细节)
创建一个 Issue 是开启讨论并收集 Ember 社区其他成员意见的好方法。一旦做出决定,您或其他成员可以自愿处理该任务,并提交包含相关工作的 Pull Request。
除了创建新的 Issue 和 Pull Request 外,另一种参与贡献的方式是对现有的 Issue 和 Pull Request 进行评论。参与审查的人越多,我们忽略潜在问题的概率就越低。
如何入门
一个很好的入门方式是协助改进您个人遇到过的问题。例如,如果您发现某些文档不清晰,请创建一个 Issue 来指出它,并可选地提出如何简化它的建议。
查看 主要代码仓库列表,了解 Ember 项目的各个组成部分。
如果您需要灵感,可以查看 Help Wanted 仪表板来浏览相关任务。如果您是初学者,请关注带有 "Help wanted" 和 "Good first issue" 标签的 Issue。
更新 API 指南
在 API 指南中,如果您发现拼写错误或希望为某个包、方法或类提供更多详细信息,可以参考以下方法进行更改。
在页面顶部(针对该包、方法或类),您会看到“Defined in”或“Inherited from”字样。这些字样旁边就是 GitHub 上对应源代码的链接。
您可以打开链接找到注释块,提交一个 Pull Request 来更新该注释块。API 指南可能需要几周时间才能完成更新,直至未来版本最终确定。
以下是更新方法的示例。在 store.createRecord() 部分的顶部,您可以找到“Defined in”字样。
这些字样旁边同样是源代码链接:ds-model-store.ts。
请遵循具体代码仓库中的贡献指南。(这是 Ember.js 的贡献指南示例。)贡献指南可能还会详细说明如何编辑文件、编写提交信息以及运行 Lint 和测试。
寻求帮助
如果您需要帮助,请直接在 Issue 和 PR 中评论。这样其他人也能看到并提供帮助。您还可以访问 Ember.js 社区页面加入 Ember.js Discord 服务器。以 dev 开头的频道专为从事相应项目贡献者准备,是提问的好地方。
总结
最后,我们要再次重申——无论您的技术水平如何,都可以提供帮助!如果您有任何改善项目的想法,我们非常期待您的贡献!