fix bullet point formatting in contributing.rst

IMMM-SFA · Sep 27, 2024 · 40a1bf4 · 40a1bf4
1 parent f57ee19
commit 40a1bf4
Showing 1 changed file with 10 additions and 5 deletions.
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -14,20 +14,25 @@ Contribution workflow (bug or feature)
 ______________________________________
 
 1. I found a bug!
-* Check if the bug has already been reported by searching the existing GitHub
+
+   * Check if the bug has already been reported by searching the existing GitHub
 `Issues <https://github.com/IMMM-SFA/tell/issues>`_. If you find a match, consider adding additional details to the
 existing ticket.
-* Open a `new Issue <https://github.com/IMMM-SFA/tell/issues/new/choose>`_, being sure to include a clear title and
+
+   * Open a `new Issue <https://github.com/IMMM-SFA/tell/issues/new/choose>`_, being sure to include a clear title and
 description along with as much detail as possible; code samples or log messages demonstrating the bug are quite helpful.
 
 2. I fixed a bug!
-* Open a `new Pull Request <https://github.com/IMMM-SFA/tell/compare>`_ with the fix. Ensure the description clearly
+
+   * Open a `new Pull Request <https://github.com/IMMM-SFA/tell/compare>`_ with the fix. Ensure the description clearly
 outlines the bug and the solution. Include the Issue number if applicable.
 
 3. I created a new feature!
-* Consider opening a `new Issue <https://github.com/IMMM-SFA/tell/issues/new/choose>`_ to describe use cases for the
+
+   * Consider opening a `new Issue <https://github.com/IMMM-SFA/tell/issues/new/choose>`_ to describe use cases for the
 new feature. This will offer a platform for discussion and critique.
-* Then, open a `new Pull Request <https://github.com/IMMM-SFA/tell/compare>`_ with clear documentation of the
+
+   * Then, open a `new Pull Request <https://github.com/IMMM-SFA/tell/compare>`_ with clear documentation of the
 methodology. Be sure to include new unit tests if appropriate.