update contrib

CONTRIBUTING.md

@@ -18,13 +18,15 @@ If your proposed changes are more extensive than a few lines of code, please cre
 Follow these steps to submit a pull request:
 
 1. Fork the `spey` repository.
-2. Open an issue and discuss the implementation with the developers.
-3. Commit your changes to a feature branch on your fork and push all your changes.
-4. Start a draft pull request and inform the developers about your progress.
-5. Pull the ``main`` branch to ensure there are no conflicts with the current code developments.
-6. Modify the appropriate section of
+2. Install pre-commit using `pip install pre-commit`
+3. Go to `spey` main folder and type `pre-commit install`.
+4. Open an issue and discuss the implementation with the developers.
+5. Commit your changes to a feature branch on your fork and push all your changes.
+6. Start a draft pull request and inform the developers about your progress.
+7. Pull the ``main`` branch to ensure there are no conflicts with the current code developments.
+8. Modify the appropriate section of
    `docs/releases/changelog-dev.md`.
-7. Once complete, request a review from one of the maintainers.
+9. Once complete, request a review from one of the maintainers.
 
 #### Docstring style
 

docs/contributing.rst

@@ -21,13 +21,15 @@ Pull request procedure
 
 Follow these steps to submit a pull request:
 
-1. Fork the ``spey`` repository.
-2. Open an issue and discuss the implementation with the developers.
-3. Commit your changes to a feature branch on your fork and push all your changes.
-4. Start a draft pull request and inform the developers about your progress.
-5. Pull the ``main`` branch to ensure there are no conflicts with the current code developments.
-6. Modify the appropriate section of  ``docs/releases/changelog-dev.md``.
-7. Once complete, request a review from one of the maintainers.
+1. Fork the `spey` repository.
+2. Install pre-commit using `pip install pre-commit`
+3. Go to `spey` main folder and type `pre-commit install`.
+4. Open an issue and discuss the implementation with the developers.
+5. Commit your changes to a feature branch on your fork and push all your changes.
+6. Start a draft pull request and inform the developers about your progress.
+7. Pull the ``main`` branch to ensure there are no conflicts with the current code developments.
+8. Modify the appropriate section of `docs/releases/changelog-dev.md`.
+9. Once complete, request a review from one of the maintainers.
 
 Docstring style
 ~~~~~~~~~~~~~~~
@@ -66,5 +68,5 @@ Throughout the code, the following documentation style has been employed
         {{descriptionPlaceholder}}
     {{/returns}}
 
-This code can directly be imported into ``custom.mustache`` file and used within
+This script can directly be imported into ``custom.mustache`` file and used within
 vscode as an auto docstring generator.

src/spey/base/hypotest_base.py

@@ -36,7 +36,7 @@ def __dir__():
 
 log = logging.getLogger("Spey")
 
-# pylint: disable=W1203,C0103
+# pylint: disable=W1203,C0103,possibly-used-before-assignment
 
 
 class HypothesisTestingBase(ABC):