UserGuide icon indicating copy to clipboard operation
UserGuide copied to clipboard

[user story] The process of a PR (core repo)

Open IAlibay opened this issue 2 years ago • 5 comments
trafficstars

User story

A user may want to know the process of doing a PR - i.e. from the time you open one, what should you expect etc...

IAlibay avatar Sep 29 '23 10:09 IAlibay

Then is the information to be put in the webiste?

kumarvaastavi avatar Oct 25 '23 21:10 kumarvaastavi

Hi @kumarvaastavi, the solution to this issue would be documentation on what happens to a pull request made to the core https://github.com/MDAnalysis/mdanalysis repository -- and yes, the end result would be that this documentation would go up on the https://userguide.mdanalysis.org/stable/index.html website. However, the documentation has yet to be written -- we're hoping to get around to it soon!

lilyminium avatar Oct 25 '23 21:10 lilyminium

Then can I work on it and pull a request later?

kumarvaastavi avatar Oct 25 '23 21:10 kumarvaastavi

Hmm, so this issue is about documenting a process that happens within the MDAnalysis core repository -- while a new perspective would be welcome here, it may be better suited for someone more experienced with opening, reviewing and merging pull requests in MDAnalysis to address this issue initially. If you're looking for something to get started with MDAnalysis, I would recommend looking at the core repository first :)

lilyminium avatar Oct 25 '23 21:10 lilyminium

Thanks for the guidance, I will look at the core repository first

kumarvaastavi avatar Oct 25 '23 21:10 kumarvaastavi