-
Notifications
You must be signed in to change notification settings - Fork 8
Open
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation
Description
Hi @vergauwenthomas,
I am using CONTRIBUTING.md as a reference for contribution. I would like to highlight some possible changes that might improve the overall experience.
- Minimum version of Python is set to 3.9 which should be changed to 3.10. Changes required here:
conda create -n metobs_dev python==3.9 poetry - There is no
source deploiment/build_and_test.sh. Maybe you are referring tosource deployment/develop_pipeline.sh? -
deployment/develop_pipeline.shis hard-coded to some of the applications such asgeany. I suggest to use something more of generic approach such as
- After the git checkout, make editable install using
pip install -e .
- Install
pre-commithooks using
pip install --user pre-commit
pre-commit install
- Run tests preferably using
pytest. If you want to usepoetry. Better to write in theCONTRIBUTING.md. - Some tests require GEE account. Not all people developing will have a connected GEE account. It is better to have an option to skip these while developing. When PR is ready to be merged then it must pass all tests through GitHub workflows.
Feel free to provide your thoughts. I have provided these suggestions based on my experience with xarray and ultraplot contributions.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
documentationImprovements or additions to documentationImprovements or additions to documentation