More detailed CONTRIBUTING guide

[DalerAsrorov]

Hey Seb, could you spend some time on writing more detailed contributing guide? Currently the guide is a bit general so a step-by-step guide on how to run experiments and see visualizations after those experiments would be great. I haven't touched randpot for quite some time so need to refresh (to see if some visualizations improvements I could do in the mean time). Would appreciate a thorough CONTRIBUTING guide. Thanks!

[seba-1511]

Hi Daler,

Thanks for opening the issue, I agree that the guide is light on explanations. I'll try to flesh it out as soon as I have a bit of time. Do you have an example of good contributing guidelines template we could inspire ourselves from ?

Regarding a step-by-step guide on how to run / visualize experiments, I'd recommend looking at the wiki. There are some basic and more advanced tutorials, including some on the visualization features we discussed last time.

Cheers,
Séb

[DalerAsrorov]

Thanks for quick reply and link to wiki, forgot about wikis. One of the good and simples ones I thought to share is from britecharts contributing guide. Especially the list of commands section. They have description of how to set up to add new features to chart, in randopt's case, it would probably be how to set up environment to run different experiments with some notes on debugging.
React's guide is great, although it might be too broad for the project, just following their format should be good enough. Hope this helps!