Skip to content

Commit f355390

Browse files
committed
add note to changelog
1 parent 3b54876 commit f355390

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

docs/source/about/changelog.rst

+7-1
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,15 @@ Changelog
1111
All notable changes to this project will be recorded in this document. The style of
1212
which is based on `Keep a Changelog <https://keepachangelog.com/>`__. The versioning
1313
scheme for the project adheres to `Semantic Versioning <https://semver.org/>`__. For
14-
more info, see the :ref:`Contributor Guide <Create a Changelog Entry>`.
14+
more info, see the :ref:`Contributor Guide <Creating a Changelog Entry>`.
1515

1616

17+
.. INSTRUCTIONS FOR CHANGELOG CONTRIBUTORS
18+
.. !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
19+
.. If you're adding a changelog entry, be sure to read the "Creating a Changelog Entry"
20+
.. section of the documentation before doing so for instructions on how to adhere to the
21+
.. "Keep a Changelog" style guide (https://keepachangelog.com).
22+
1723
Unreleased
1824
----------
1925

docs/source/about/contributor-guide.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ about how to get started. To make a change to IDOM you'll do the following:
6666
:ref:`equality checks <Code Quality Checks>` and, with any luck, accept your request.
6767
At that point your contribution will be merged into the main codebase!
6868

69-
Create a Changelog Entry
70-
........................
69+
Creating a Changelog Entry
70+
..........................
7171

7272
As part of your pull request, you'll want to edit the `Changelog
7373
<https://github.com/idom-team/idom/blob/main/docs/source/about/changelog.rst>`__ by

0 commit comments

Comments
 (0)