Skip to content

Commit

Permalink
Merge pull request #170 from arcondello/reno-in-readme
Browse files Browse the repository at this point in the history
Update README's Contributing section with Release Note subsection
  • Loading branch information
arcondello authored Nov 18, 2024
2 parents a3e2275 + 6138d75 commit 48edb9b
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <setup.cfg>`_ files.

Release Notes
~~~~~~~~~~~~~

``dwave-optimization`` makes use of `reno <https://docs.openstack.org/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 <https://docs.openstack.org/reno/latest/user/usage.html>`_
for details.

0 comments on commit 48edb9b

Please sign in to comment.