mirror of
https://github.com/ARM-software/arm-trusted-firmware.git
synced 2025-04-16 09:34:18 +00:00
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:
parent
10c969c5bb
commit
832df3cc3b
1 changed files with 15 additions and 26 deletions
|
@ -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
|
||||
|
|
Loading…
Add table
Reference in a new issue