As mentioned in this forum topic, I am looking to contribute to the GROMACS project as part of a university course requirement. Since I lack in-depth knowledge of the software and its theoretical foundations, I found the Doxygen documentation upgrade, discussed in issue 4690, to be a suitable starting point. I would appreciate your feedback on whether this upgrade would be a valuable contribution. My goal is to complete this work by the end of January.
Hi!
I think that would be a very welcome contribution. As discussed in #4690, prior to any code changes one would need to make a decision about which Doxygen version to target (I personally lean towards the latest, 1.12). After you make your MR, someone from the core team would have to rebuild the CI container image (should not be a problem, but see below).
One potential problem is that GROMACS has release planned for the early February, so most of the effort would be focused there. As a result, review/feedback/etc might be slow. Do you need to have your contribution accepted by the deadline or just have something close to completion? Would you be able to do follow-ups later?
Hi,
I haven’t started yet, as the contribution topic still needs to be discussed with both the developers and the course organizers. I’m also open to handling follow-ups later if needed. While it’s great that my contribution could potentially be accepted (merged) by the deadline in early February, I believe the course organizers evaluate the entire process rather than just focusing on the merge itself.