提交约定

编辑此页

Symfony CMF 对提交使用约定。这不是向 CMF 贡献代码的要求，但它是为了让大型新功能具有有意义的提交。

合并提交

在合并 Pull Request 之前，应该合并提交（即 Pull Request 中应该只有一个包含你所有工作的提交）。

你可以使用 git rebase 轻松合并提交，如下所示

        1
        $ git rebase --interactive HEAD~<number of commits in your pull request>
    

例如，如果你的 github 上的 pull request 有 4 个提交

        1
        $ git rebase --interactive HEAD~4
    

然后你的编辑器会显示一个类似这样的屏幕

        1
2
3
4
        pick 5d4530b port features from simple cms into routing bundle to simplify things
pick 1a0eea3 cs fixes and cleanups according to feedback
pick 8cbab56 convert settings to options
pick 8f3e4f9 cleanups for the options refactoring
    

告诉 github 选择第一个并合并其余的，如下所示

        1
2
3
4
        pick 5d4530b port features from simple cms into routing bundle to simplify things
s 1a0eea3 cs fixes and cleanups according to feedback
s 8cbab56 convert settings to options
s 8f3e4f9 cleanups for the options refactoring
    

保存文件并退出。GIT 现在应该合并你所有的提交并要求你输入新的提交信息。

提交信息

提交信息应按以下格式格式化

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        [<scope>] <short description>

Fixes: <list of issues fixed>

<long description>

BC Breaks (as required)
---------

<list of BC breaks and required migrations>

Deprecations (as required)
------------

<list of deprecations>
    

例如，修复 2 个问题并添加 2 个 BC breaks 的 PR 的提交信息将是

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
        [Initializer] Initializers use ManagerRegistry

Fixes: #1234, #4321

Initializers are now passed an instance of `ManagerRegistry` instead
of the `Phpcr\Session`. This means that initializers can retrieve both
the PHPCR session and the `DocumentManager`.

This PR also introduces a requirement that all initializers provide a name
which can be used in diagnostics.

BC Breaks
---------

- The `init` method of the InitializerInterface now accepts a
  `ManagerResistry` instead of a `PhpcrSession`. The PHPCR session can
  be retrieved using `$registry->getConnection` and the manager with
  `$registry->getManager()`;

- The first argument to the `GenericInitializer` constructor is now the
  name of the initializer.
    

简短提交信息

并非所有 Pull Request 都需要如此多的提交信息。在大多数情况下，更简单的提交约定就足够了

        1
        <bug|feature|minor> [<scope>] <short description>
    

其中 bug 指的是修复 bug 的提交，feature 指的是添加功能的提交，而 minor 指的是添加不太相关内容的提交（修复代码标准、添加注释、修复错别字等）。

这项工作，包括代码示例，均根据 Creative Commons BY-SA 3.0 许可获得许可。

版本