diff options
| author | Andrew Klychkov <aklychko@redhat.com> | 2021-03-24 16:21:34 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-03-24 16:21:34 +0100 |
| commit | 0543916a866c1238223f2a839fd530b96769bb71 (patch) | |
| tree | 95b177b4814462afa64a180a183392120c24b2c0 | |
| parent | apt_key - update key ID and URL used in test (diff) | |
| download | ansible-0543916a866c1238223f2a839fd530b96769bb71.tar.xz ansible-0543916a866c1238223f2a839fd530b96769bb71.zip | |
Docsite: clarify a changelog entry format (#73902)
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Felix Fontein <felix@fontein.de>
Co-authored-by: Sandra McCann <samccann@redhat.com>
| -rw-r--r-- | docs/docsite/rst/community/development_process.rst | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/docs/docsite/rst/community/development_process.rst b/docs/docsite/rst/community/development_process.rst index e977d8c562..45d2104d9b 100644 --- a/docs/docsite/rst/community/development_process.rst +++ b/docs/docsite/rst/community/development_process.rst @@ -184,7 +184,25 @@ A single changelog fragment may contain multiple sections but most will only con Each changelog entry must contain a link to its issue between parentheses at the end. If there is no corresponding issue, the entry must contain a link to the PR itself. -Most changelog entries will be ``bugfixes`` or ``minor_changes``. When writing a changelog entry that pertains to a particular module, start the entry with ``- [module name] -`` and the following sentence with a lowercase letter. +Most changelog entries are ``bugfixes`` or ``minor_changes``. + +Changelog fragment entry format +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ + +When writing a changelog entry, use the following format: + +.. code-block:: yaml + + - scope - description starting with a lowercase letter and ending with a period at the very end. Multiple sentences are allowed (https://github.com/reference/to/an/issue or, if there is no issue, reference to a pull request itself). + +The scope is usually a module or plugin name or group of modules or plugins, for example, ``lookup plugins``. While module names can (and should) be mentioned directly (``foo_module``), plugin names should always be followed by the type (``foo inventory plugin``). + +For changes that are not really scoped (for example, which affect a whole collection), use the following format: + +.. code-block:: yaml + + - Description starting with an uppercase letter and ending with a dot at the very end. Multiple sentences are allowed (https://github.com/reference/to/an/issue or, if there is no issue, reference to a pull request itself). + Here are some examples: |