saltstack/salt
1
0
Fork 0
mirror of https://github.com/saltstack/salt.git synced 2025-04-10 14:51:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Update docs to reflect pre-commit check

Browse source 
The changelog files should have a `.md` extension, but the CONTRIBUTING.rst does not reflect it, yet
This commit is contained in:
Henrik Hüttemann 2024-01-19 16:35:27 +01:00 • committed by Daniel Wozniak
parent a76d5c47ef
commit 2eef6d6489
2 changed files with 2 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTING.rst
View file

@ -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

0
changelog/65888.fixed → changelog/65888.fixed.md
View file