docs(commit-style): fix incorrect instructions for adding scopes

Change-Id: I3ce7abd1c21b084dea6b618c603f71b5bb4c50e8
Signed-off-by: Chris Kay <chris.kay@arm.com>
This commit is contained in:
Chris Kay 2022-10-10 16:50:14 +01:00
parent 10c969c5bb
commit 832df3cc3b

View file

@ -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:
greatest new platform `Bar` then you would add it to the `Platforms` changelog
sub-section, and the hierarchy should look something like this:
.. code:: json
.. code:: yaml
{
"sections": [
{
"title": "Platforms",
"sections": [
{
"title": "Foo",
"scopes": ["foo"],
"sections": [
{
"title": "Bar",
"scopes": ["bar"]
}
]
}
]
}
]
}
- 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