From 40a1bf40d8a820ec7085410e3f946e8e77ccb90e Mon Sep 17 00:00:00 2001 From: erexer <13180883+erexer@users.noreply.github.com> Date: Fri, 27 Sep 2024 15:40:06 -0700 Subject: [PATCH] fix bullet point formatting in contributing.rst --- docs/source/contributing.rst | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst index e25c91a1..9146c721 100644 --- 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 `_. If you find a match, consider adding additional details to the existing ticket. -* Open a `new Issue `_, being sure to include a clear title and + + * Open a `new Issue `_, 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 `_ with the fix. Ensure the description clearly + + * Open a `new Pull Request `_ 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 `_ to describe use cases for the + + * Consider opening a `new Issue `_ to describe use cases for the new feature. This will offer a platform for discussion and critique. -* Then, open a `new Pull Request `_ with clear documentation of the + + * Then, open a `new Pull Request `_ with clear documentation of the methodology. Be sure to include new unit tests if appropriate.