diff options
| author | Chris Kay <chris.kay@arm.com> | 2022-10-10 16:50:14 +0100 |
|---|---|---|
| committer | Chris Kay <chris.kay@arm.com> | 2022-11-04 17:20:18 +0100 |
| commit | 832df3cc3bd1e0e26ac1b31687c63949a0ac15db (patch) | |
| tree | 0e2bea5883ac5994bc154ac60ffe8886e05c33b9 /docs/process/commit-style.rst | |
| parent | 10c969c5bbee4b1a3e0f603b4765d8c60a5af162 (diff) | |
| download | arm-trusted-firmware-832df3cc3bd1e0e26ac1b31687c63949a0ac15db.tar.gz | |
docs(commit-style): fix incorrect instructions for adding scopes
Change-Id: I3ce7abd1c21b084dea6b618c603f71b5bb4c50e8
Signed-off-by: Chris Kay <chris.kay@arm.com>
Diffstat (limited to 'docs/process/commit-style.rst')
| -rw-r--r-- | docs/process/commit-style.rst | 45 |
1 files changed, 17 insertions, 28 deletions
diff --git a/docs/process/commit-style.rst b/docs/process/commit-style.rst index de899ab1f..9213fe561 100644 --- a/docs/process/commit-style.rst +++ b/docs/process/commit-style.rst @@ -96,36 +96,25 @@ locally, as commitlint reports a live list of the acceptable scopes. Adding Scopes ------------- -Scopes that are either a) unblessed in the configuration file, or b) do not -exist in the configuration file at all are considered to be deprecated. If you -are adding a new component that does not yet have a designated scope, please -feel free to add one. +Scopes that are not present in the changelog configuration file are considered +to be deprecated, and should be avoided. If you are adding a new component that +does not yet have a designated scope, please add one. For example, if you are adding or making modifications to `Foo`'s latest and -greatest new platform `Bar`, you would add it to the `Platforms` changelog -section, and the hierarchy should look something like this: - -.. code:: json - - { - "sections": [ - { - "title": "Platforms", - "sections": [ - { - "title": "Foo", - "scopes": ["foo"], - "sections": [ - { - "title": "Bar", - "scopes": ["bar"] - } - ] - } - ] - } - ] - } +greatest new platform `Bar` then you would add it to the `Platforms` changelog +sub-section, and the hierarchy should look something like this: + +.. code:: yaml + + - title: Platforms + + subsections: + - title: Foo + scope: foo + + subsections: + - title: Bar + scope: bar When creating new scopes, try to keep them short and succinct, and use kebab case (``this-is-kebab-case``). Components with a product name (i.e. most |