update contribution guidelines

icecube / flarestack

Unbinned likelihood analysis code for astroparticle physics datasets

https://flarestack.readthedocs.io/en/latest/?badge=latest

MIT License

8 stars 7 forks source link

update contribution guidelines #201

Closed JannisNe closed 2 years ago

JannisNe commented 2 years ago

I do love the review workflow a lot. To document that somewhere also for potential new contributors I revamped the CONTRIBUTING.md. Let me know what you think.

JannisNe commented 2 years ago

Good point. As per review guideline, which one would you pick? I would think

Required for major changes only, optional otherwise

sounds reasonable. One week for a reviewer to answer sounds good.

robertdstein commented 2 years ago

Good point. As per review guideline, which one would you pick? I would think
* Required for major changes only, optional otherwise
sounds reasonable. One week for a reviewer to answer sounds good.

I agree "Required for major changes only, optional otherwise" sounds reasonable

mlincett commented 2 years ago

Text looks nice, I did some proofreading.

About the reproducibility part, I would try to word it more carefully: on the long run, I do not think we want to store many (and possibly large) catalogues inside the flarestack repository - the AGN analysis takes 32 MiB of space already.

JannisNe commented 2 years ago

Well, we don't say explicitly that catalogues should be included. Also in the future, they will definitely not be because IceCube analyses are now documented in the internal GitHub and flarestack is then only a dependency. In that sense we could even remove the reproducibility part completely because it's not flarestacks responsibility.

mlincett commented 2 years ago

Well, we don't say explicitly that catalogues should be included.

Agree, but I'd rather be explicit against their inclusion in the repo :) I committed some changes to the text but feel free to amend.

JannisNe commented 2 years ago

Looks good!