From 2eef6d6489b3d027874b4eddaa8411305c257927 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Henrik=20H=C3=BCttemann?= Date: Fri, 19 Jan 2024 16:35:27 +0100 Subject: [PATCH] Update docs to reflect pre-commit check The changelog files should have a `.md` extension, but the CONTRIBUTING.rst does not reflect it, yet --- CONTRIBUTING.rst | 4 ++-- changelog/{65888.fixed => 65888.fixed.md} | 0 2 files changed, 2 insertions(+), 2 deletions(-) rename changelog/{65888.fixed => 65888.fixed.md} (100%) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index ee4ab88e193..cae5a62bbbd 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -562,12 +562,12 @@ But that advice is backwards for the changelog. We follow the `keepachangelog `__ 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 ``.`` format. For +``salt/changelog`` directory, using the ``..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 b/changelog/65888.fixed.md similarity index 100% rename from changelog/65888.fixed rename to changelog/65888.fixed.md