Added development section to the readme

.gitignore

@@ -12,3 +12,4 @@ docs/source/sg_execution_times.rst
 docs/site
 docs/generated
 site
+src/osipi.egg-info

README.md

@@ -33,7 +33,61 @@ We welcome contributions to OSIPI! To contribute, follow these steps:
 - Push your changes to your fork.
 - Submit a pull request to the main OSIPI repository.
 
-For more details on how to contribute, visit the [Developer Guide](https://osipi.github.io/pypi/developers_guide/index.html).
+## Development Setup
+
+We used poetry to manage the dependencies for this project.
+
+### Using Poetry
+
+1. If you don't have Poetry installed, you can install it using pip:
+
+    ```bash
+    pip install poetry
+    ```
+
+    Or, if you're using a Unix-based system, you can install it using the following command:
+
+    ```bash
+    curl -sSL https://install.python-poetry.org | python3 -
+    ```
+
+    For more information on installing Poetry, see the [official documentation](https://python-poetry.org/docs/)
+2. Clone the repository to your local machine.
+3. Navigate to the project directory.
+4. Install the project dependencies with Poetry:
+
+    ```bash
+    poetry install
+    ```
+
+5. Activate the Poetry environment:
+
+    ```bash
+    poetry shell
+    ```
+
+## Setting up pre-commit
+
+`pre-commit` is a tool that we use to maintain high-quality code in this project. It runs checks (hooks) on your code each time you commit changes. Here's how to set it up:
+
+
+1. In the project directory, run the following command to install the `pre-commit` hooks:
+
+    ```bash
+    pre-commit install
+    ```
+
+2. You can run all pre-commit hooks on all files with:
+
+    ```bash
+    pre-commit run --all-files
+    ```
+**NOTE:**
+- Next times you commit changes, `pre-commit` will run the hooks automatically.
+- Some of hooks automatically fix/format your files to specific standards. If you see that some of your files have been changed after a commit, don't worry! It's just `pre-commit` doing its job.
+  Add the changes and commit them again.
+
+For more details on how to contribute, visit the [Developer Guide](https://osipi.github.io/pypi/contribution/#making-a-pull-request-pr-to-the-osipi-package).
 #### As mentioned before, this project is still in the early stages of development. If you'd like to contribute by adding functionality, we recommend opening an issue first to discuss your proposed functionality and the best ways to implement it.
 
 ## Details

mkdocs.yml

@@ -41,7 +41,9 @@ theme:
 
 plugins:
   - mkdocstrings:
-      default_handler: python
+      handlers:
+        python:
+          paths: ["src"]
   - gallery:
       examples_dirs: docs/examples
       gallery_dirs: docs/generated/gallery