Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
fabcor-maxiv opened this issue Jul 4, 2024 · 4 comments

Comments

@fabcor-maxiv
Copy link
Contributor

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 mxcube/mxcubeweb#1283 (comment)

@fabcor-maxiv
Copy link
Contributor Author

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
Copy link
Member

marcus-oscarsson commented Jul 4, 2024

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

@fabcor-maxiv
Copy link
Contributor Author

fabcor-maxiv commented Jul 5, 2024

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
Copy link
Member

marcus-oscarsson commented Jul 5, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants