Finalize contributing

Author: domna

docs/contributing.md

@@ -2,39 +2,75 @@
 
 We're happy that you are interested in contributing to pyElli!
 
-There are several ways of contributing to pyElli.
-The easiest is reporting issues or starting discussions.
-If you want to dive deeper feel free to open a pull request or contact us
-if you need some help.
-We're eager to help you if you want to contribute code to pyElli even if you feel
-you don't bring a lot of knowledge (yet). We are happy to assist.
+You can contribute by reporting issues, starting discussions or open pull requests yourself
+to contribute code directly.
+In case you need help don't hesitate to ask for it.
 
 ## Reporting an Issue
 
 If you are encountering problems with pyElli or have a feature request
-please open an issue at our [Github Issues Page](https://github.com/PyEllips/pyElli/issues).
+open an issue at pyElli's [Github Issues Page](https://github.com/PyEllips/pyElli/issues).
 
-Please try to provide a minimal example for reproducing the issue.
-This makes it a lot easier for the developers to work on the problem.
+Ideally, you'll provide a minimal example to reproduce the issue.
+This will make it a lot easier to work on the problem.
 
 If you are not entirely sure whether the problem you're encountering is actually a bug
-or if you want to discuss some feature ideas feel free to post on our [Github Discussion Page](https://github.com/orgs/PyEllips/discussions)
+or if you want to discuss some feature ideas feel free to post on pyElli's [Github Discussion Page](https://github.com/orgs/PyEllips/discussions)
 
 ## Making a Pull Request
 
+In case you want to contribute your own code to pyElli you can open a pull request.
+To do this you need to fork pyElli first and create the pull request from your fork.
+[Github's excellent documentation on the topic](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) will be helpful if you need help to create a fork.
+
+### Setting up the repository and development environment
+
+First, clone the repo to start working on the code.
+Replace `https://github.com/PyEllips/pyElli` with the url of your fork.
+
 ```sh
 git clone --recurse-submodules https://github.com/PyEllips/pyElli
 cd pyElli
 ```
 
+In the next step we install the package in development mode.
+We recommend using [uv](https://docs.astral.sh/uv/), which will manage a dedicated python
+virtual environment for the project.
+However, any virtual environment should work.
+
+=== "uv"
+
+    ```sh
+    uv sync --extra dev --extra docs --extra fitting
+    ```
+
 === "pip"
 
     ```sh
     pip install -e '.[dev,docs,fitting]
     ```
 
+Now you're ready to make your changes to the code.
+
+### Testing
+
+Before opening a pull request please ensure that the tests pass and the code passes
+the linting checks and is formatted properly.
+We use the tool [ruff](https://docs.astral.sh/ruff/) to check linting and formatting
+and [pytest](https://docs.pytest.org/en/stable/) for testing.
+
 === "uv"
 
     ```sh
-    uv sync --extra dev --extra docs --extra fitting
+    uv run pytest
+    uv run ruff check .
+    uv run ruff format .
+    ```
+
+=== "pip"
+
+    ```sh
+    pytest
+    ruff check .
+    ruff format .
     ```

docs/explanation/index.md

@@ -0,0 +1 @@
+# Learning

docs/howto/fitting_multiple_angles.md

@@ -1,3 +1,3 @@
-# Custom Fitting
+# Fitting Multiple Angles
 
 Custom fitting

docs/howto/mueller_matrix.md

@@ -1,3 +1,3 @@
-# Mueller Matrix
+# Mueller Matrix Fitting
 
 Mueller matrix

docs/tutorial/working_with_dispersions.md

@@ -1,6 +1,7 @@
-# Working with Dispersions
+# Working with Dispersions Models
 
-TODO:
-- How to construct and add dispersions
-- Formula dispersions
-- How to load dispersions from rii
+## Adding Dispersions
+
+## Using a Formula Dispersion
+
+## Using Dispersions from refractiveindex.info

mkdocs.yml

@@ -21,6 +21,7 @@ nav:
   - Tutorials:
     - tutorial/index.md
     - tutorial/simple_fit.md
+    - tutorial/working_with_dispersions.md
   - How-Tos:
     - howto/index.md
     - howto/fitting_multiple_angles.md