Directions for Contributors about climetlab HOT 4 CLOSED

Hi @emadehsan, yes you are most that welcome to contribute to climetlab.

The documentation would be a good starting point. Perhaps you want to improve this part https://climetlab.readthedocs.io/en/latest/guide/sources.html by giving more details or add some example in https://climetlab.readthedocs.io/en/latest/guide/howtos.html.

Your feedback in setting up your dev environment would be also welcome, we would like contributors to be able to build the documentations and run the test without wasting time installing missing packages and fighting dependencies.

from climetlab.

@floriankrb thanks so much! :)

I'll start from there

from climetlab.

Hi @floriankrb , would appreciate your thoughts about the structure of CliMetLab documentation and how it can possibly be improved

1. Having Developer Guide > Datasets page when User Guide > Datasets already exists would probably be redundant. Same can be said about Data sources page. Having a single Datasets page describing all the dataset related functionality (available to both User and Developer) might help maintain a single source of truth.

2. Also, I feel that having separate User Guide,Contributor Guide and Developer Guide could be a little confusing and sometimes repetitive?
   I think that the hierarchy of the documentation would be much simpler and easier to navigate if it is organized with respect to topic (e.g. Plugin, Datasets, Data sources) instead of persona (User > Datasets, Developer > Data Sources, Contributor > Plugins).

from climetlab.

It's own issue #31

from climetlab.