search

MDAnalysis / UserGuide

User Guide for MDAnalysis
https://userguide.mdanalysis.org
22 stars 31 forks source link

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

Open IAlibay opened 9 months ago

IAlibay commented 9 months ago

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...

kumarvaastavi commented 8 months ago

Then is the information to be put in the webiste?

lilyminium commented 8 months ago

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!

kumarvaastavi commented 8 months ago

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

lilyminium commented 8 months ago

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 :)

kumarvaastavi commented 8 months ago

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