Skip to content

Commit 5e27866

Browse files
committed
changelog entry
1 parent 37ecb17 commit 5e27866

File tree

2 files changed

+11
-6
lines changed

2 files changed

+11
-6
lines changed

docs/source/about/changelog.rst

+6-2
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,17 @@ Changelog
1010

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
13-
scheme for the project adheres to `Semantic Versioning <https://semver.org/>`__.
13+
scheme for the project adheres to `Semantic Versioning <https://semver.org/>`__. For
14+
more info, see the :ref:`Contributor Guide <Create a Changelog Entry>`.
1415

1516

1617
Unreleased
1718
----------
1819

19-
Nothing yet...
20+
Changed:
21+
22+
- The name of ``proto`` modules to ``types`` and added a top level ``idom.types`` module
23+
- :pull:`701`
2024

2125

2226
0.37.1

docs/source/about/contributor-guide.rst

+5-4
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,11 @@ about how to get started. To make a change to IDOM you'll do the following:
6969
Create a Changelog Entry
7070
........................
7171

72-
As part of your pull request, you'll want to edit the :ref:`Changelog` by adding an
73-
entry describing what you've changed or improved. You should write an entry in the style
74-
of `Keep a Changelog <https://keepachangelog.com/>`__ that falls under one of the
75-
following categories, and add it to the :ref:`Unreleased` section of the changelog:
72+
As part of your pull request, you'll want to edit the `Changelog
73+
<https://github.com/idom-team/idom/blob/main/docs/source/about/changelog.rst>`__ by
74+
adding an entry describing what you've changed or improved. You should write an entry in
75+
the style of `Keep a Changelog <https://keepachangelog.com/>`__ that falls under one of
76+
the following categories, and add it to the :ref:`Unreleased` section of the changelog:
7677

7778
- **Added** - for new features.
7879
- **Changed** - for changes in existing functionality.

0 commit comments

Comments
 (0)