How to update code used in a published paper without breaking reproducibility? #197884
Replies: 1 comment
-
|
Thank you for your interest in contributing to our community! We currently only accept discussions created through the GitHub UI using our provided discussion templates. Please re-submit your discussion by navigating to the appropriate category and using the template provided. This discussion has been closed because it was not submitted through the expected format. If you believe this was a mistake, please reach out to the maintainers. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hi everyone,
I’m completely new to GitHub and I'm looking for some advice on the best way to handle version control for an academic project.
The Situation:
I have a repository containing a script used for an exhaustive parameter search to compute a function
f(a,b,c). The code groups results by another functionE(a,b,c) = i. Currently, the script simply checks whether there exists a combination of parameters satisfyingE(a,b,c) = isuch thatf(a,b,c) > 0.This specific version of the code is cited in a conference paper that has already been presented.
The Goal:
I now need to make a very minor update (just 1 or 2 lines) to the logic. Instead of just checking if
f > 0, I want the code to output the "best" result found for eachi.The original version is "frozen" in the context of the published paper, I want to ensure that anyone reading the paper can still find and run the exact code used for those results, while still allowing the repository to show the new, improved version as the "main" code.
Should I simply overwrite the current file (because the change is really minor) and mention the change in the
README?Should I keep two separate files in the same folder (e.g.,
compute_check.pyandcompute_optimize.py)?Or is there a "standard" GitHub feature (like Tags, Releases, or Branches) that is preferred for marking a version used in a specific publication?
I want to follow best practices for academic transparency and reproducibility. Any advice would be greatly appreciated!
Thanks in advance!
Beta Was this translation helpful? Give feedback.
All reactions