From 6138d75e57f430a4978b15d765d1051791d95d82 Mon Sep 17 00:00:00 2001 From: Alexander Condello Date: Mon, 18 Nov 2024 08:24:58 -0800 Subject: [PATCH] Update README's Contributing section with Release Note subsection --- README.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.rst b/README.rst index c2093a52..d656bd99 100644 --- a/README.rst +++ b/README.rst @@ -120,3 +120,23 @@ has guidelines for contributing to Ocean packages. ``dwave-optimization`` includes some formatting customization in the `.clang-format <.clang-format>`_ and `setup.cfg `_ files. + +Release Notes +~~~~~~~~~~~~~ + +``dwave-optimization`` makes use of `reno `_ +to manage its release notes. + +When making a contribution to ``dwave-optimization`` that will affect users, +create a new release note file by running + +.. code-block:: bash + + reno new your-short-descriptor-here + +You can then edit the file created under ``releasenotes/notes/``. +Remove any sections not relevant to your changes. +Commit the file along with your changes. + +See reno's `user guide `_ +for details.