mirror of
https://github.com/ceph/ceph-csi.git
synced 2024-11-22 06:10:22 +00:00
doc: add list of valid components to the development guide
The commitlint CI job uses the configuration from .commitlintrc.yaml which contains the different components that Ceph-CSI uses. A short description of each component has been added, so that contributors understand what component to mention in the prefix of the subject in commit messages. Signed-off-by: Niels de Vos <ndevos@redhat.com>
This commit is contained in:
parent
3be9d99573
commit
25ea25368a
@ -122,13 +122,31 @@ Signed-off-by: Random J Developer <random@developer.example.org>
|
||||
The format can be described more formally as follows:
|
||||
|
||||
```text
|
||||
<subsystem>: <what changed>
|
||||
<component>: <subject of the change>
|
||||
<BLANK LINE>
|
||||
<why this change was made>
|
||||
<paragraph(s) with reason/description>
|
||||
<BLANK LINE>
|
||||
<footer>
|
||||
<signed-off-by>
|
||||
```
|
||||
|
||||
The `component` in the subject of the commit message can be one of the following:
|
||||
|
||||
* `cephfs`: bugs or enhancements related to CephFS
|
||||
* `rbd`: bugs or enhancements related to RBD
|
||||
* `doc`: documentation updates
|
||||
* `util`: utilities shared between components use `cephfs` or `rbd` if the
|
||||
change is only relevant for one of the type of storage
|
||||
* `journal`: any of the journalling functionalities
|
||||
* `helm`: deployment changes for the Helm charts
|
||||
* `deploy`: updates to Kubernetes templates for deploying components
|
||||
* `build`: anything related to building Ceph-CSI, the executable or container
|
||||
images
|
||||
* `ci`: changes related to the Continuous Integration, or testing
|
||||
* `e2e`: end-to-end testing updates
|
||||
* `cleanup`: general maintenance and cleanup changes
|
||||
* `revert`: undo a commit that was merged by mistake, use of one of the other
|
||||
components is in most cases recommended
|
||||
|
||||
The first line is the subject and should be no longer than 70 characters, the
|
||||
second line is always blank, and other lines should be wrapped at 80 characters.
|
||||
This allows the message to be easier to read on GitHub as well as in various
|
||||
|
Loading…
Reference in New Issue
Block a user