contribution guide for plugins

[larsbuntemeyer]

Hi everybody,
i am using compliance-checker to check CF conventions of my model output for the CORDEX-CMIP6 MIP. We are also implementing some more CORDEX and CORDEX CV specific checks and i was evaluating if this could become a plugin for the compliance-checker since it offers a very nice framework and reporting capabilities. However, I am not sure how to start. I am not sure, if the plugin system was meant to be used also by external contributors. I was starting to dig through the code, e.g., of the ioos/cc-plugin-glider, but it's hard to get a grasp on it. It seems that i should start probably to inherit from BaseNCCheck and define an entry point, e.g., like here?

https://github.com/ioos/cc-plugin-glider/blob/24c3cfd70c69c97a720f74bc74f8a642c02b616d/pyproject.toml#L34

Thanks a lot!

[ocefpaf]

I am not sure, if the plugin system was meant to be used also by external contributors.

It was designed for that use case.

I should start probably to inherit from BaseNCCheck and define an entry point, e.g., like here?

Maybe this one is a better starting point for you. It is a bit simpler and newer than the glider one.

[larsbuntemeyer]

Thanks, nice example, that's making it much easier to start!

[ocefpaf]

I cannot take merit for it. @jcermauwedu is the one that created this nice plugin.