Add contributing guidelines

mobie / mobie-viewer-fiji

BSD 2-Clause "Simplified" License

30 stars 12 forks source link

Add contributing guidelines #1040

Closed k-dominik closed 1 year ago

k-dominik commented 1 year ago

I am aware that development setup is also up to taste - I summarized here what worked for me. I think having something here is better than nothing.

Summary:

added initial contributing guidelines to ease onboarding of new developers
cleanup: removed scripts generated by install.sh
Note: in install.sh I removed the custom JAVA_HOME - when conda for development (and maybe also in general?!) this should not be necessary to set manually

tischi commented 1 year ago

Thanks a lot! Also this is awesome!!

Shall we add something to CONTRIBUTING.md that this is also shipped as a Fiji plugin? Right now it feels a bit conda CLI centric...

k-dominik commented 1 year ago

Well, if there is a way to run fiji with this development version of the plugin, yes, then this should definitely be documented. I have no clue how to do that, so could you maybe add this?

I assume the development setup would be a bit different if you want to run it in your system Fiji installation - but I'm not sure I'd even recommend it.