Salt: Contributing Docs do not mention changelog

Created on 7 Apr 2020  路  3Comments  路  Source: saltstack/salt

Description of Issue

Changelog is in use and to add to the log it is more than a commit message, we should have that documented in the docs

Setup

https://docs.saltstack.com/en/latest/topics/development/contributing.html#sending-a-github-pull-request

Steps to Reproduce Issue

N/A

Versions Report

N/A

Aluminium Bug Documentation doc-request phase-plan severity-medium status-to-do

All 3 comments

@saltstack/docs-working-group

do we also need information on towncrier in the contributing docs?

The good thing is that the following can be used:

:ref:`changelog`

As towncrier changelog directions were added via #56984, this should now be an easier fix since we'd be able to insert it as a simple reference. In order to avoid merge conflicts, this is currently blocked by #57645

Was this page helpful?
0 / 5 - 0 ratings