Update docs to reflect pre-commit check

The changelog files should have a `.md` extension, but the CONTRIBUTING.rst does not reflect it, yet
jynolen · Jan 25, 2024 · 2eef6d6 · 2eef6d6
1 parent a76d5c4
commit 2eef6d6
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -562,12 +562,12 @@ But that advice is backwards for the changelog. We follow the
 `keepachangelog <https://keepachangelog.com/en/1.0.0/>`__ approach for
 our changelog, and use towncrier to generate it for each release. As a
 contributor, all that means is that you need to add a file to the
-``salt/changelog`` directory, using the ``<issue #>.<type>`` format. For
+``salt/changelog`` directory, using the ``<issue #>.<type>.md`` format. For
 instance, if you fixed issue 123, you would do:
 
 ::
 
-   echo "Made sys.doc inform when no minions return" > changelog/123.fixed
+   echo "Made sys.doc inform when no minions return" > changelog/123.fixed.md
 
 And that's all that would go into your file. When it comes to your
 commit message, it's usually a good idea to add other information, such as

diff --git a/changelog/65888.fixed → changelog/65888.fixed.md b/changelog/65888.fixed → changelog/65888.fixed.md