docs: updated contributor guide

[musslick]

Description

This PR updates the contributor guide to the current version of autora 4.0.0 (see detailed list of fixed below).

• resolves contributor documentation must be public #625
• resolves doc: check and update contributor guide #557

Type of change

• docs: Documentation only changes

Features (Optional)

• removal of the autora-workflow package from the description of core packeges.
• updated examples of theorist and experimentalist implementations, primarily to be based on pandas dataframes
• added requirement for contributor repo to be public for inclusion in autora package

Questions (Optional)

• In the modules/index.md the lists inside the Success and Hint boxes aren't rendering properly. They are just listed without a line brak. I tried changing the "-" to "*" but not sure if that fixed it?

[hollandjg]

• In the modules/index.md the lists inside the Success and Hint boxes aren't rendering properly. They are just listed without a line brak. I tried changing the "-" to "*" but not sure if that fixed it?

They're just missing a couple of newlines. I've pushed an extra commit which makes the block look like:

!!! success
    
    In order for your package to be included in the parent package, it must meet the following criteria:
    
    * have basic documentation in ``docs/index.md``
    * have a basic python notebook exposing how to use the module in ``docs/Basic Usage.ipynb``
    * have basic tests in ``tests/``
    * be published via PyPI or Conda
    * be compatible with the current version of the parent package
    * follow standard python coding guidelines including PEP8
    * the repository in which your package is hosted must be public

The following demonstrates how ...

... which renders like:

[hollandjg]

Hi Sebastian,
this looks great! The information is really clear and concise, and covers everything.
The documentation looks really awesome.
I've a couple of very minor changes to suggest, some of which are in a separate PR. #629

[hollandjg]

We still have `autora-workflow` in the diagram here.

My feeling is that the dependency arrows point in the wrong direction here, but that might be a question for a different PR and a different day – I know that the way they are feels intuitive for many.

[musslick]

That's a great catch! We could use the most recent figure from the paper draft. I will create an issue so we can address it in a new PR.

[hollandjg]

This line looks to be formatted incorrectly – it should show __init__.py not init.py

You may implement your code in the ``__init__.py`` located in the respective feature folder in ``src/autora``.

[musslick]

Thanks for the catch! I committed a fix implementing the suggested renaming from 'init.py' to 'init.py'

[musslick]

Thanks for adding the line breaks; I didn't know this could help!

[musslick]

Hi Sebastian, this looks great! The information is really clear and concise, and covers everything. The documentation looks really awesome. I've a couple of very minor changes to suggest, some of which are in a separate PR. #629

Thanks a lot John for all the fixes! I approved the request with all the fixes you implemented.

[hollandjg]

LGTM!