diff options
| author | Donatas Abraitis <donatas@opensourcerouting.org> | 2023-01-31 11:36:38 +0100 |
|---|---|---|
| committer | Donatas Abraitis <donatas@opensourcerouting.org> | 2023-01-31 12:25:27 +0100 |
| commit | 19b8d68cf8ea0dca722b1630edd9e6834a126fc0 (patch) | |
| tree | 99adadec357bebecb60a5859456eae172731619d /doc/developer/workflow.rst | |
| parent | tools: Add commit linter (diff) | |
| download | frr-19b8d68cf8ea0dca722b1630edd9e6834a126fc0.tar.xz frr-19b8d68cf8ea0dca722b1630edd9e6834a126fc0.zip | |
doc: Add a documentation about commit conventions
Signed-off-by: Donatas Abraitis <donatas@opensourcerouting.org>
Diffstat (limited to '')
| -rw-r--r-- | doc/developer/workflow.rst | 13 |
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 88ee35838..605525818 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -354,6 +354,19 @@ Before merging make sure a PR has squashed the following kinds of commits: This helps to automatically generate human-readable changelog messages. +Commit Guidelines +----------------- + +There is a built-in commit linter. Basic rules: + +- Commit messages must be prefixed with the name of the changed subsystem, followed + by a colon and a space and start with an imperative verb. + + `Check <https://github.com/FRRouting/frr/tree/master/.github/commitlint.config.js>`_ all + the supported subsystems. + +- Commit messages must start with a capital letter +- Commit messages must not end with a period ``.`` .. _license-for-contributions: |