贡献

我们希望您能为我们的项目做出贡献，并帮助使其变得更好！作为贡献者，以下是我们希望您遵循的准则。

报告问题

如果您在源代码中发现错误或在文档中发现错误，则可以通过将问题提交到我们的GitHub来帮助我们。包括问题重现(通过Stackblitz，Plunkr等) 是帮助团队快速诊断问题的绝对最佳方法。屏幕截图也很有帮助。

您可以提供更多帮助，并提交包含修复程序的请求请求。

在您提交问题(issue)之前，请搜索档案，也许您的问题已被回答。

如果您的问题似乎是Bug，并且尚未报告，请打开一个新问题。不报告重复问题，帮助我们最大程度地投入精力来解决问题和添加新功能。提供以下信息将增加迅速解决您的问题的机会：

您可以通过向我们的GitHub提交issue来请求新功能。如果您想实施一项新功能，请先提交一份有关您的工作的建议书，以确保我们可以采纳它。请考虑这是什么变化：

对于主要功能，请先打开一个issue并概述您的建议，以便进行讨论。
这也将使我们能够更好地协调我们的工作，防止工作重复，并帮助您进行更改，使更改成功地被接受到项目中。
可以制作小功能，并直接作为Pull提交。

在提交Pull请求(PR)之前，请考虑以下准则：

搜索 GitHub 中与您提交的内容有关的开放或关闭的PR
创建一个新的git分支:
```
git checkout -b my-fix-branch master
```
在本地分支上进行更改。
运行完整的测试套件，并确保所有测试均通过。
使用我们commit message guidelines 中描述性提交消息来提交更改. 必须遵守这些约定，以保持干净的git日志。
将您的分支推送到GitHub:
```
git push origin my-fix-branch
```
在GitHub上,向ngxs:master发送一个pull request.
如果建议更改，那么就需要:
- 进行所需的更新。
- 重新运行测试套件，以确保测试仍然通过。
- 重新设置分支基础并强制推送到GitHub上的库(这将更新你的 Pull Request):
  git rebase master -i git push -f

就是这样！感谢您的贡献！

每个提交消息都由一个 header, 一个 body 和一个 footer组成。标头具有一种特殊的格式，包括一个 type, 一个 scope 和一个 subject:

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

header是必须的，标头的 scope 是可选的。

提交消息的任何一行都不能超过100个字符！这使得该消息在GitHub以及各种git工具中更易于阅读。

如果该提交恢复了先前的提交，则应以revert:开头，然后是恢复后的提交的标头。在主体中应该注明：This reverts commit <hash>.，其中哈希是要还原的提交的SHA。

必须为以下之一：

可以是指定提交更改位置的任何内容。例如Store, Mutation, Action, Select等。

包含对变更的简洁描述：

和subject中一样，使用现在时态的命令："change" 而不是 "changed" 或 "changes"。body应包括改变的动机，并将其与以前的行为进行对比。

Footer应包含有关Breaking Changes的所有信息，并且也是引用Closes的GitHub问题的地方。

Breaking Changes应以单词 BREAKING CHANGE: 开头，并以空格或两个换行符开头。然后，将其余的提交消息用于此。

Last updated 4 years ago

Was this helpful?