search

ecmwf / climetlab

Python package for easy access to weather and climate data
Apache License 2.0
374 stars 58 forks source link

Directions for Contributors #29

Closed emadehsan closed 2 years ago

emadehsan commented 3 years ago

Hi @floriankrb , CliMetLab's documentation needs work and a new contributor can perhaps start by writing test-cases for new features too. What would be your advice for someone looking to contribute to CliMetLab? Where to start?

I'm passionate about working on Climate Change and CliMetLab seems like a perfect start. Pedro recommended CliMetLab to me.

floriankrb commented 3 years ago

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.

emadehsan commented 3 years ago

@floriankrb thanks so much! :)

I'll start from there

emadehsan commented 2 years ago

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).

emadehsan commented 2 years ago

It's own issue https://github.com/ecmwf/climetlab/issues/31