search

mxcube / mxcubecore

Backend used by MXCuBE
http://mxcube.github.io/mxcube/
GNU Lesser General Public License v3.0
11 stars 52 forks source link

Should we move the contributing guidelines from root into Sphinx documentation? #955

Open fabcor-maxiv opened 3 months ago

fabcor-maxiv commented 3 months ago

I'm wondering, should we move the contents of CONTRIBUTING.md so that its only in the sphinx documentation and simply only have a link pointing to the part in CONTRIBUTING.md. I know that CONTRIBUTING.md is automatically included but it can be a bit confusing.

_Originally posted by @marcus-oscarsson in https://github.com/mxcube/mxcubeweb/pull/1283#discussion_r1665177546_

fabcor-maxiv commented 3 months ago

This should be done for mxcubeweb as well. And it also brings the question: how do we keep contributing guidelines in sync in both web and core?

marcus-oscarsson commented 3 months ago

We can simply link from mxcubeweb to the "contributing" section in mxubecore ?

fabcor-maxiv commented 3 months ago

We can simply link from mxcubeweb to the "contributing" section in mxubecore ?

I was under the impression that there were differences in the contributing guidelines between core and web, so that would not be a "simply do" thing. But I have not looked closely enough yet, so maybe it is indeed simple : )

marcus-oscarsson commented 3 months ago

I've not read them very recently so I cant really tell for certain, but our idea was always to keep them as similar as possible so I would be surprised if there are bigger incompatible changes. If there are some I guess we can make on web specific section (if really needed) and then link to the rest in mxcubecore. The python part should in my opinion be the same, then there might be some UI specific things.